Skip to content

Docs: Document the docs/release publishing flow - #5729

Merged
bfops merged 2 commits into
masterfrom
docs/document-docs-release-flow
Aug 13, 2026
Merged

Docs: Document the docs/release publishing flow#5729
bfops merged 2 commits into
masterfrom
docs/document-docs-release-flow

Conversation

@cloutiertyler

Copy link
Copy Markdown
Contributor

Description of Changes

Adds a "Releasing the Docs" section to docs/README.md documenting how the live docs site is published:

  • The site is built from the docs/release branch (via the Docs / Publish workflow), not from master.
  • The release procedure is to force-push master's head to docs/release:
    git push --force origin origin/master:docs/release
  • Explains why the force-push is expected and safe: the Docs / Update llms files workflow commits generated llms.md output directly to docs/release, so that branch always drifts ahead of master with disposable build-output commits.
  • Warns against committing hand-written content directly to docs/release.

This removes the ambiguity where docs/release had commits not on master and it was unclear how to update it without losing them.

API and ABI breaking changes

None — documentation only.

Expected complexity level and risk

1

Testing

  • Documentation change only; verified the described flow by performing a docs release with it today (both workflows triggered and succeeded).

@bfops bfops left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

LGTM thank you!

@cloutiertyler
cloutiertyler added this pull request to the merge queue Aug 12, 2026
@github-merge-queue
github-merge-queue Bot removed this pull request from the merge queue due to failed status checks Aug 12, 2026
@bfops
bfops added this pull request to the merge queue Aug 12, 2026
@github-merge-queue
github-merge-queue Bot removed this pull request from the merge queue due to failed status checks Aug 12, 2026
@bfops
bfops added this pull request to the merge queue Aug 12, 2026
@github-merge-queue
github-merge-queue Bot removed this pull request from the merge queue due to failed status checks Aug 12, 2026
@bfops
bfops added this pull request to the merge queue Aug 12, 2026
@joshua-spacetime
joshua-spacetime removed this pull request from the merge queue due to the queue being cleared Aug 12, 2026
@bfops
bfops enabled auto-merge August 12, 2026 20:29
@bfops
bfops added this pull request to the merge queue Aug 13, 2026
Merged via the queue into master with commit f204baf Aug 13, 2026
42 checks passed
@bfops bfops mentioned this pull request Aug 13, 2026
8 tasks
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.

4 participants