Skip to content

docs: one file per topic, and one page for every release - #534

Merged
huyplb merged 1 commit into
mainfrom
docs/organize-and-release-summary
Oct 16, 2026
Merged

huyplb merged 1 commit into
mainfrom
docs/organize-and-release-summary

Conversation

@huyplb

@huyplb huyplb commented Oct 16, 2026 •

Copy link
Copy Markdown
Contributor

Summary

  • Living guides are install.md, user-guide.md, workflow.md, and publish.md. The index is docs/README.md.
  • Finished plans moved under docs/plans. Homebrew and Docker Hub pages that repeated the install guide are removed.
  • Every shipped version is summarized in docs/releases/SUMMARY.md. The per-version release files stay as the GitHub Release bodies.

Test plan

  • packages/shared/src/doc-paths.test.ts

Made with Cursor


Note

Low Risk
Documentation and link updates only; no application runtime or API behavior changes.

Reviewed by Cursor Bugbot for commit fb78ea1. Bugbot is set up for automated code reviews on this repo. Configure here.

Living guides use the same names as the rest of the docs. Finished plans sit under docs/plans. Homebrew and Docker Hub pages that repeated the install guide are gone. Every shipped version is summarized in docs/releases/SUMMARY.md.

Co-authored-by: Cursor <cursoragent@cursor.com>
@huyplb
huyplb merged commit 5e0f8b1 into main Oct 16, 2026
10 checks passed
@huyplb
huyplb deleted the docs/organize-and-release-summary branch October 16, 2026 04:05
@cursor

cursor Bot commented Oct 16, 2026

Copy link
Copy Markdown
Contributor

Bugbot couldn't run - usage limit reached

Bugbot is counted against Cursor usage for this user or team, and this run hit a usage or spend limit.

A user or team admin can review and increase usage limits in the Cursor dashboard.

(requestId: a8aec731-206a-4444-9c3c-fb632c473684)

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.

1 participant