feat(fusion-tsdoc-readme): add reusable TSDoc and README documentation skill#125
Draft
feat(fusion-tsdoc-readme): add reusable TSDoc and README documentation skill#125
Conversation
…n skill Orchestrator skill with three agents (tsdoc, readme, reviewer) for systematic documentation passes across monorepo packages. Includes: - SKILL.md with repo-aware conventions discovery, TSDoc pass, README pass, review council, and multi-package orchestration - tsdoc.agent.md for export scanning and TSDoc improvement - readme.agent.md for README structure assessment and rewrite - reviewer.agent.md for four-dimension quality review - references/readme-structure.md for consistent README format - references/orchestration.md for multi-package batching strategy - assets/readme-template.md for package README scaffold Resolves equinor/fusion-core-tasks#702
Contributor
Changeset summaryDetected 1 changeset file(s): .changeset/add-fusion-tsdoc-readme-skill.md: ---
"fusion-tsdoc-readme": minor
---
Add reusable skill for systematic TSDoc and README documentation passes
- Orchestrator SKILL.md with TSDoc pass, README pass, and review council workflow
- Three agents: tsdoc (export scanning and TSDoc improvement), readme (structure assessment and rewrite), reviewer (four-dimension quality review)
- References for README structure guide and multi-package orchestration strategy
- README template asset for consistent package documentation
Resolves equinor/fusion-core-tasks#702 |
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.
Why
No reusable skill exists for systematic TSDoc and README documentation passes across packages. The workflow was proven effective across a 41-package documentation sprint on
equinor/fusion-framework(equinor/fusion-core-tasks#599) but required bespoke prompts every time — no consistent quality bar, no orchestration guidance, and no review council.Current behavior
fusion-code-conventionsNew behavior
New
fusion-tsdoc-readmeorchestrator skill with:Delegates TSDoc convention rules to
fusion-code-conventions(declared inmetadata.skills) rather than duplicating them.References
Reviewer focus
npx -y skills add . --listoutput, passesvalidate:skillsandvalidate:ownershipSelf review checklist