chore: module documentation standard (SPEC-005) - #21
Open
kriss145 wants to merge 3 commits into
Open
Conversation
Contributor
Author
|
@pkarw @dominikpalatynski Could you look into it? |
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
@open-mercato/*packages in this monorepopackages/<name>/README.md(shortened docs with real content) →packages/<name>/docs/*.md(extended docs split into files)skill/SKILL.mdas a required artifact for modules with extensible APIs (e.g. base classes, convention file patterns)What's in this PR
.ai/specs/SPEC-005-2026-05-18-module-documentation-standard.md— full specificationImplementation plan (follow-up PRs)
AGENTS.md, updatescaffold-moduleskill to generate docs scaffolding, add GitHub Actions docs-check workflowcarrier-inpostfollowing the standardReference
The
packages/pdf-generatorsmodule (onfeat/pdf-generators) served as the design reference — its documentation structure is the closest existing example of what this standard formalizes.