Skip to content

docs: integrate extension publishing guide into documentation site - #5163

Merged
mnriem merged 1 commit into
github:mainfrom
mnriem:mnriem-extension-publishing-docs
Oct 28, 2026
Merged

mnriem merged 1 commit into
github:mainfrom
mnriem:mnriem-extension-publishing-docs

Conversation

@mnriem

@mnriem mnriem commented Oct 28, 2026

Copy link
Copy Markdown
Collaborator

Description

Move the Extension Publishing Guide from extensions/EXTENSION-PUBLISHING-GUIDE.md to docs/extensions/publishing.md so it is published on the documentation website.

  • Include the new directory in DocFX and add Community > Publishing Extensions to site navigation.
  • Update existing references and use published-site URLs for publishing-guide links outside docs/.
  • Repair the moved guide's outgoing documentation links.
  • Clarify that submissions not using the issue template will be closed with a request to resubmit using it.

Testing

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

Documentation-only change; CLI tests and sample-project testing were not run.

  • docfx docs/docfx.json — passed with zero errors and three existing warnings about parent-directory globs and an unrelated link in docs/reference/core.md.
  • git diff --check — passed.
  • Previewed the publishing guide locally and confirmed the Community navigation points to the generated page.

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 using GPT-6.1 Sol (model ID: gpt-6.1-sol), default reasoning settings, autonomous editing under human direction. AI assistance covered the documentation move, navigation and link updates, submission-policy wording, local preview, validation, commit, and PR preparation. No CLI runtime code was changed.

Move the guide into docs/extensions, wire DocFX navigation, update references, and clarify the required submission process.

Assisted-by: GitHub Copilot (model: GPT-6.1 Sol, autonomous)
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot AI max review requested due to automatic review settings October 28, 2026 16: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 review issues remain for the publishing-guide relocation and related documentation updates.

No open issues 🎉

What changed in this PR

Publishes the Extension Publishing Guide on Spec Kit’s documentation site and connects it to the community contribution documentation.

Changes:

  • Moves the guide into docs/extensions/ and adds DocFX inclusion and community navigation.
  • Updates references to the relocated guide and repairs outgoing documentation links.
  • Clarifies that submissions must use the issue template.
File Description
extensions/​template/​README.md Links starter projects to the published guide.
extensions/​README.md Updates the catalog submission guidance link.
extensions/​EXTENSION-USER-GUIDE.md Updates the publishing resource link.
extensions/​EXTENSION-DEVELOPMENT-GUIDE.md Links publishing instructions to the documentation site.
docs/​toc.yml Adds Publishing Extensions under Community.
docs/​reference/​catalogs.md Uses a site-relative publishing-guide link.
docs/​README.md Lists the guide in the documentation structure.
docs/​extensions/​publishing.md Relocates the guide, repairs links, and clarifies submission policy.
docs/​docfx.json Includes extension documentation in the site build.
docs/​community/​overview.md Links contributors to the relocated guide.
docs/​community/​extensions.md Updates the extension submission guidance link.
.github/​skills/​add-community-extension/​SKILL.md Updates the publishing-rules source path.
.github/​ISSUE_TEMPLATE/​extension_submission.yml Points the submission form to the published guide.

Review effort: Max

@mnriem
mnriem merged commit 7f45114 into github:main Oct 28, 2026
16 checks passed
@mnriem
mnriem deleted the mnriem-extension-publishing-docs branch October 28, 2026 17:04
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