Repository navigation
docs: consolidate and correct preset documentation - #5223
Merged
mnriem merged 2 commits intoNov 3, 2026
Merged
Conversation
Consolidate preset guidance under docs/presets with canonical overview, CLI, authoring, API, catalog, and publishing pages. Update navigation and inbound links, remove obsolete guides, and align documented behavior with the implementation. Assisted-by: GitHub Copilot App (model: GPT-6.1 Sol, autonomous) Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
No active issues were identified, and the change is limited to consolidating and updating preset documentation without altering runtime behavior.
No open issues 🎉
What changed in this PR
This documentation-only PR consolidates preset guidance under docs/presets/, updates navigation and inbound links, aligns content with current preset and catalog behavior, and removes superseded documentation. Runtime behavior is unchanged.
Changes:
- Added overview, CLI, development, API, catalog, and publishing documentation.
- Updated navigation, cross-references, README links, community guidance, and submission instructions.
- Removed obsolete preset architecture, publishing, and reference pages.
- Updated the catalog-trust documentation test to use the canonical catalogs page.
| File | Summary |
|---|---|
tests/test_catalog_trust_docs.py |
Points the catalog trust test to the canonical catalogs page. |
README.md |
Updates preset links to the new overview page. |
presets/scaffold/README.md |
Updates the publishing guide link. |
presets/README.md |
Retains a concise directory guide with canonical documentation links. |
presets/PUBLISHING.md |
Removes the superseded publishing document. |
presets/ARCHITECTURE.md |
Removes the superseded architecture document. |
docs/toc.yml |
Adds the presets documentation section and removes the old reference entry. |
docs/reference/presets.md |
Removes the superseded preset reference page. |
docs/reference/overview.md |
Links to the new preset overview and CLI reference. |
docs/reference/catalogs.md |
Updates preset catalog and publishing references. |
docs/README.md |
Lists the new preset documentation pages. |
docs/presets/publishing.md |
Documents release testing and issue-based catalog submission. |
docs/presets/overview.md |
Provides the canonical preset overview and composition model. |
docs/presets/developing.md |
Documents preset authoring, ignore files, and testing guidance. |
docs/presets/cli.md |
Documents preset management commands and JSON output. |
docs/presets/catalogs.md |
Documents catalog configuration, releases, caching, authentication, and trust. |
docs/presets/api.md |
Documents manifests, resolution, composition, lifecycle, and installed state. |
docs/integrations/index.md |
Updates the preset customization reference. |
docs/index.md |
Updates the main preset documentation link. |
docs/guides/customization.md |
Updates preset overview, CLI, and API references. |
docs/docfx.json |
Includes the preset documentation directory in builds. |
docs/community/presets.md |
Links to the consolidated publishing guide. |
docs/community/overview.md |
Updates community publishing guidance. |
.github/ISSUE_TEMPLATE/preset_submission.yml |
Points contributors to the canonical publishing guide. |
Review effort: Lite (auto)
Resolve overlapping navigation and links while retaining the extension and preset documentation sections. Assisted-by: GitHub Copilot App (model: GPT-6.1 Sol, autonomous) Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
No active issues were identified in the documentation-focused consolidation, which updates related links, navigation, and the catalog-trust test path without changing runtime behavior.
No open issues 🎉
Review effort: Lite (auto)
2 of 5 tasks
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.
Description
Consolidates preset documentation under
docs/presets/, following the extension documentation consolidation in #5221. Adds canonical overview, CLI, developing, API, catalogs, and publishing pages, with navigation and inbound links updated to their new homes.Removes
docs/reference/presets.md,presets/ARCHITECTURE.md, andpresets/PUBLISHING.mdwithout forwarding stubs. Keepspresets/README.mdas a directory guide and leaves the community listing indocs/community/presets.md.Aligns guidance with current manifest validation, composition, active-integration command/skill delivery, constitution synchronization, update failure behavior, catalog releases and trust, opt-in authentication, and issue-based publishing. Updates the publishing link in the submission form and the existing catalog-trust documentation test's canonical path.
This is documentation-only, including documentation build configuration and a documentation-test path update. Preset runtime behavior, package contributions, catalogs, and submission automation are unchanged.
Testing
uv run specify --helpuv sync && uv run pytestValidation:
uv run specify --help— passed.LC_ALL=en_US.UTF-8 .venv/bin/python -m pytest tests/test_presets.py tests/specify_cli/presets tests/test_community_preset_validation.py -q— 882 passed.LC_ALL=en_US.UTF-8 .venv/bin/python -m pytest tests/test_catalog_trust_docs.py tests/test_github_workflows.py -q— 160 passed.npx --no-install markdownlint-cli2 'docs/presets/*.md' docs/README.md docs/community/overview.md docs/community/presets.md docs/guides/customization.md docs/index.md docs/integrations/index.md docs/reference/catalogs.md docs/reference/overview.md— passed, no issues.docfx docs/docfx.json(session-local DocFX installation) — passed with the same three warnings as the baseline.git diff --check— passed.Also verified all six pages appear in the generated site and navigation, checked 207 local HTML links and anchors, validated the complete YAML manifest example against the current validator, and found no obsolete preset documentation paths in tracked text files.
The full test suite and a coding-agent sample-project process were not run for this documentation-only change.
AI Disclosure
AI disclosure: Authored with GitHub Copilot App using GPT-6.1 Sol (
gpt-6.1-sol), in autonomous agent mode with runtime-default reasoning settings and human-directed scope. AI assistance covered documentation consolidation, source comparison, documentation corrections, validation, the documentation-test path update, and PR preparation. No runtime code was changed.