mkdocs2confluence 0.13.2__tar.gz → 0.13.4__tar.gz

{mkdocs2confluence-0.13.2/src/mkdocs2confluence.egg-info → mkdocs2confluence-0.13.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocs2confluence
-Version: 0.13.2
+Version: 0.13.4
 Summary: Publish MkDocs Material pages to Confluence Cloud — admonitions, Mermaid diagrams, tabs, page properties and more
 Author: Anders Hybertz
 License: GPL-3.0-or-later
@@ -58,7 +58,10 @@ Dynamic: license-file
 
 A Python CLI tool that compiles MkDocs-flavoured Markdown into **native Confluence storage XHTML** and publishes it directly to Confluence Cloud. It is a **compiler/transpiler**, not an HTML converter — every construct maps to its native Confluence equivalent, so pages look and behave like hand-authored Confluence content.
 
-It also bridges the gap between Confluence reviewers and developers: the `sync-comments` command turns open Confluence page comments into GitHub pull request review threads, and auto-resolves them in Confluence when the PR is merged.
+- **Publish** — compiles your full `nav:` tree and pushes only changed pages (SHA-256 skip, no unnecessary version bumps or notifications).
+- **What's New page** — designate a `CHANGELOG.md` with `confluence.changelog` and mk2conf publishes it as a pinned top-level page on every run, so Confluence readers always have one place to see what changed.
+- **AI changelog skill** — `mk2conf install-skill` installs a bundled AI skill into your editor (Claude Code, Copilot, Cursor, Hermes) that analyses git changes to your docs and drafts a dated entry in `CHANGELOG.md` when the changes are significant.
+- **Review bridge** — `sync-comments` turns open Confluence page comments into GitHub pull request review threads and auto-resolves them in Confluence when the PR is merged.
 
 > **Zensical compatible** — [Zensical](https://zensical.org/) is the modern successor to MkDocs + Material for MkDocs. Since it uses the same `mkdocs.yml` format and Python Markdown extensions, your Zensical project works with mk2conf today with no changes required.
 
@@ -128,12 +131,15 @@ mk2conf preview --page index.md --watch
 # Dry-run: see what would be published
 mk2conf publish --dry-run
 
-# Publish all nav pages
+# Publish all nav pages (and the changelog page if configured)
 mk2conf publish
 
 # Export a section to PDF
 mk2conf pdf --section Guide --out guide.pdf
 
+# Install the changelog AI skill into your editor
+mk2conf install-skill
+
 # Sync Confluence comments to GitHub PR review threads
 mk2conf sync-comments
 ```

{mkdocs2confluence-0.13.2 → mkdocs2confluence-0.13.4}/README.md

@@ -16,7 +16,10 @@
 
 A Python CLI tool that compiles MkDocs-flavoured Markdown into **native Confluence storage XHTML** and publishes it directly to Confluence Cloud. It is a **compiler/transpiler**, not an HTML converter — every construct maps to its native Confluence equivalent, so pages look and behave like hand-authored Confluence content.
 
-It also bridges the gap between Confluence reviewers and developers: the `sync-comments` command turns open Confluence page comments into GitHub pull request review threads, and auto-resolves them in Confluence when the PR is merged.
+- **Publish** — compiles your full `nav:` tree and pushes only changed pages (SHA-256 skip, no unnecessary version bumps or notifications).
+- **What's New page** — designate a `CHANGELOG.md` with `confluence.changelog` and mk2conf publishes it as a pinned top-level page on every run, so Confluence readers always have one place to see what changed.
+- **AI changelog skill** — `mk2conf install-skill` installs a bundled AI skill into your editor (Claude Code, Copilot, Cursor, Hermes) that analyses git changes to your docs and drafts a dated entry in `CHANGELOG.md` when the changes are significant.
+- **Review bridge** — `sync-comments` turns open Confluence page comments into GitHub pull request review threads and auto-resolves them in Confluence when the PR is merged.
 
 > **Zensical compatible** — [Zensical](https://zensical.org/) is the modern successor to MkDocs + Material for MkDocs. Since it uses the same `mkdocs.yml` format and Python Markdown extensions, your Zensical project works with mk2conf today with no changes required.
 
@@ -86,12 +89,15 @@ mk2conf preview --page index.md --watch
 # Dry-run: see what would be published
 mk2conf publish --dry-run
 
-# Publish all nav pages
+# Publish all nav pages (and the changelog page if configured)
 mk2conf publish
 
 # Export a section to PDF
 mk2conf pdf --section Guide --out guide.pdf
 
+# Install the changelog AI skill into your editor
+mk2conf install-skill
+
 # Sync Confluence comments to GitHub PR review threads
 mk2conf sync-comments
 ```

{mkdocs2confluence-0.13.2 → mkdocs2confluence-0.13.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "mkdocs2confluence"
-version = "0.13.2"
+version = "0.13.4"
 description = "Publish MkDocs Material pages to Confluence Cloud — admonitions, Mermaid diagrams, tabs, page properties and more"
 readme = "README.md"
 license = { text = "GPL-3.0-or-later" }

{mkdocs2confluence-0.13.2 → mkdocs2confluence-0.13.4/src/mkdocs2confluence.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocs2confluence
-Version: 0.13.2
+Version: 0.13.4
 Summary: Publish MkDocs Material pages to Confluence Cloud — admonitions, Mermaid diagrams, tabs, page properties and more
 Author: Anders Hybertz
 License: GPL-3.0-or-later
@@ -58,7 +58,10 @@ Dynamic: license-file
 
 A Python CLI tool that compiles MkDocs-flavoured Markdown into **native Confluence storage XHTML** and publishes it directly to Confluence Cloud. It is a **compiler/transpiler**, not an HTML converter — every construct maps to its native Confluence equivalent, so pages look and behave like hand-authored Confluence content.
 
-It also bridges the gap between Confluence reviewers and developers: the `sync-comments` command turns open Confluence page comments into GitHub pull request review threads, and auto-resolves them in Confluence when the PR is merged.
+- **Publish** — compiles your full `nav:` tree and pushes only changed pages (SHA-256 skip, no unnecessary version bumps or notifications).
+- **What's New page** — designate a `CHANGELOG.md` with `confluence.changelog` and mk2conf publishes it as a pinned top-level page on every run, so Confluence readers always have one place to see what changed.
+- **AI changelog skill** — `mk2conf install-skill` installs a bundled AI skill into your editor (Claude Code, Copilot, Cursor, Hermes) that analyses git changes to your docs and drafts a dated entry in `CHANGELOG.md` when the changes are significant.
+- **Review bridge** — `sync-comments` turns open Confluence page comments into GitHub pull request review threads and auto-resolves them in Confluence when the PR is merged.
 
 > **Zensical compatible** — [Zensical](https://zensical.org/) is the modern successor to MkDocs + Material for MkDocs. Since it uses the same `mkdocs.yml` format and Python Markdown extensions, your Zensical project works with mk2conf today with no changes required.
 
@@ -128,12 +131,15 @@ mk2conf preview --page index.md --watch
 # Dry-run: see what would be published
 mk2conf publish --dry-run
 
-# Publish all nav pages
+# Publish all nav pages (and the changelog page if configured)
 mk2conf publish
 
 # Export a section to PDF
 mk2conf pdf --section Guide --out guide.pdf
 
+# Install the changelog AI skill into your editor
+mk2conf install-skill
+
 # Sync Confluence comments to GitHub PR review threads
 mk2conf sync-comments
 ```

{mkdocs2confluence-0.13.2 → mkdocs2confluence-0.13.4}/src/mkdocs_to_confluence/cli.py

@@ -544,7 +544,7 @@ def _cmd_publish(args: argparse.Namespace) -> None:
         print(f"Dry run: would publish {len(pages)} page(s) to {conf_config.base_url}")
         for page in pages:
             print(f"  {page.docs_path} → '{page.title}'")
-        if conf_config.changelog_file and not partial:
+        if conf_config.changelog_file:
             from mkdocs_to_confluence.publisher.changelog import _extract_title
             cl_path = config.docs_dir / conf_config.changelog_file
             cl_title = _extract_title(cl_path) or "What's New"
@@ -580,13 +580,12 @@ def _cmd_publish(args: argparse.Namespace) -> None:
                 prune=getattr(args, "prune", False) and not partial,
                 quiet=args.quiet,
             )
-            # Changelog is a pinned top-level page — always publish on full runs,
-            # skip on partial runs (--page / --section) like all other publish behaviour.
-            if not partial:
-                publish_changelog(
-                    config, conf_config, client, space_id,
-                    space_key=conf_config.space_key, quiet=args.quiet,
-                )
+            # Changelog is a pinned top-level page independent of the nav —
+            # always publish it when it has updates, even on partial runs.
+            publish_changelog(
+                config, conf_config, client, space_id,
+                space_key=conf_config.space_key, quiet=args.quiet,
+            )
     except ConfluenceError as exc:
         print(f"error: {exc}", file=sys.stderr)
         sys.exit(1)

{mkdocs2confluence-0.13.2 → mkdocs2confluence-0.13.4}/src/mkdocs_to_confluence/skills/mkdocs-changelog/SKILL.md

@@ -1,7 +1,7 @@
 ---
 name: mkdocs-changelog
 description: Analyse doc changes since the last CHANGELOG.md update and draft a major-change entry if the changes qualify.
-version: "1.0.0"
+version: "1.1.0"
 tags: [documentation, git, changelog, mkdocs, confluence]
 specificity: context-specific
 tool_agnostic: true
@@ -47,23 +47,31 @@ Analyse git changes to the docs directory since the last `CHANGELOG.md` commit.
 ```markdown
 ## YYYY-MM-DD — Brief title describing the major change
 
-One or two sentences summarising what fundamentally changed and why it matters to readers.
-
 ### Added
 - …
 
 ### Changed
 - …
 
+### Deprecated
+- …
+
 ### Removed
 - …
+
+### Fixed
+- …
+
+### Security
+- …
 ```
 
    Rules for the entry:
    - Date is today's date in `YYYY-MM-DD` format
-   - Sections (`Added`, `Changed`, `Removed`) are included only when non-empty
-   - No version numbers — dates only
    - Title is a brief, reader-facing description (not a git commit message)
+   - No version numbers — dates only
+   - **Include only sections that have actual content** — omit any empty section entirely
+   - Section meanings: `Added` (new content), `Changed` (updated content), `Deprecated` (content being phased out), `Removed` (deleted content), `Fixed` (corrected errors or misleading information), `Security` (security-related documentation updates)
 
    Prepend the entry above any existing entries in `CHANGELOG.md`. Do not commit — the user reviews, edits if needed, and commits manually.
 
@@ -71,7 +79,14 @@ One or two sentences summarising what fundamentally changed and why it matters t
 
 - **Do not draft an entry for every change.** The changelog is for readers who want to know what fundamentally changed, not a git log. When in doubt, do not draft.
 - **Do not commit.** Always leave the file for the user to review. The user runs `git add` and `git commit` themselves before publishing.
-- **If CHANGELOG.md does not exist yet**, create it with just the new entry (no header needed).
+- **If `CHANGELOG.md` does not exist yet**, create it with this header before the first entry:
+
+```markdown
+# Changelog
+
+All notable changes to this documentation are recorded here.
+The format is inspired by [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
+```
 
 ## Verification