Skip to content

docs: consolidate and correct preset documentation - #5223

Merged
mnriem merged 2 commits into
github:mainfrom
mnriem:mnriem-preset-documentation-consolidation
Nov 3, 2026
Merged

mnriem merged 2 commits into
github:mainfrom
mnriem:mnriem-preset-documentation-consolidation

Conversation

@mnriem

@mnriem mnriem commented Nov 3, 2026

Copy link
Copy Markdown
Collaborator

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, and presets/PUBLISHING.md without forwarding stubs. Keeps presets/README.md as a directory guide and leaves the community listing in docs/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

  • Tested locally with uv run specify --help
  • Ran existing tests with uv sync && uv run pytest
  • Tested with a sample project (if applicable)

Validation:

  • 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

  • I did not use AI assistance for this contribution
  • I did use AI assistance (fill in the disclosure below)

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.

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>
Copilot AI auto review requested due to automatic review settings November 3, 2026 17:31

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 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>
Copilot AI auto review requested due to automatic review settings November 3, 2026 17:50

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 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)

@mnriem
mnriem merged commit 911f694 into github:main Nov 3, 2026
22 checks passed
@mnriem
mnriem deleted the mnriem-preset-documentation-consolidation branch November 3, 2026 18:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants