feat: add agent-doc-sync skill for Confluence documentation auto-sync#2
Open
agzyamov wants to merge 4 commits into
Open
feat: add agent-doc-sync skill for Confluence documentation auto-sync#2agzyamov wants to merge 4 commits into
agzyamov wants to merge 4 commits into
Conversation
Author
|
@IstiN Please review when you get a chance — this adds a reusable agent-doc-sync skill to dmtools-ai-docs. |
Author
|
Thank you for the feedback! I've rewritten this to use a proper JSRunner job as suggested. What changed:
New files in
Note: since I only have read access to |
Add a reusable skill that keeps Confluence documentation pages in sync with agent configuration changes. The skill: - Detects changes to agent configs, JS actions, prompts, instructions, and CI/CD pipelines via configurable watch paths - Guides the AI through a fetch-update-publish workflow using DMtools Confluence commands - Supports configurable Confluence target (space, page title, page ID) with auto-discovery from dmtools.env - Provides a generalized page structure template (Common Configuration + Project-Specific Configuration table) - Handles edge cases: new page creation, missing files, shared actions Also adds a reference to the new skill in the main SKILL.md documentation table. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
6650bf5 to
4e1ff7f
Compare
Author
|
The branch has been cleaned up and is ready for review. What changed since the last review:
Submodule dependency: IstiN/dmtools-agents#177 — adds only the 2 new files on top of the current |
Instead of guiding the AI through manual CLI commands, the skill now delegates to a proper DMtools JSRunner job: - agents/js/agentDocSync.js (in IstiN/dmtools-agents, via fork PR epam#6) - agents/agent_doc_sync.json (in IstiN/dmtools-agents, via fork PR epam#6) Changes: - Update agents submodule pointer to feat/agent-doc-sync commit 930313b - Rewrite dmtools-ai-docs/references/agents/agent-doc-sync/SKILL.md: - Remove manual CLI step-by-step instructions - Document JSRunner job usage: ./dmtools.sh run agents/agent_doc_sync.json - Explain customParams (confluenceSpace, confluencePageTitle, etc.) - Add prerequisites and quick setup guide The job reads sm.json as source of truth, deduplicates agent config references, builds a full HTML reference table, and publishes to Confluence. Fails closed if 0 agents are discovered. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
4e1ff7f to
2a87ef2
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a reusable agent-doc-sync skill that keeps Confluence documentation pages automatically in sync with agent configuration changes. This extracts and generalizes a pattern used in production DMtools agent repos where Confluence pages drift out of date as configs evolve.
What it does
When agent-related files are created or modified, the skill guides the AI through:
confluence_update_page_with_historywith a descriptive history commentConfigurable, not hardcoded
The skill uses configurable watch paths and Confluence target, so it works in any DMtools agent repo:
agents/**/*.json,agents/**/*.js,agents/**/prompts/*.md, etc.) — users customize to their project layoutdmtools.env, user configures page title/IDFiles changed
dmtools-ai-docs/references/agents/agent-doc-sync/SKILL.md(216 lines)dmtools-ai-docs/SKILL.md(added one row to documentation table)Evaluation Results
The skill was developed using the skill-creator workflow with 3 test scenarios run both with and without the skill (6 total runs):
*Baseline also passed because the test repo already had a hardcoded documentation rule. In a fresh project without this rule, baseline scores 0/14.
Qualitative improvements with skill
Assertions verified
confluence_content_by_title_and_space,confluence_update_page_with_history)historyCommentin Confluence updates