Skip to content

Remove maintainer operations from public GitBook - #7

Merged
Utilitycoder merged 1 commit into
mainfrom
docs/public-content-boundary
Jul 26, 2026
Merged

Remove maintainer operations from public GitBook#7
Utilitycoder merged 1 commit into
mainfrom
docs/public-content-boundary

Conversation

@Utilitycoder

@Utilitycoder Utilitycoder commented Jul 26, 2026

Copy link
Copy Markdown
Contributor

Summary

  • remove the SDK delivery checklist, GitBook publishing procedure, and release procedure from the public GitBook content root
  • preserve those operational documents under .github/maintainers for repository maintainers
  • remove public navigation and reader-facing links to maintainer procedures
  • keep all builder-facing integration, API, architecture, indexing, examples, troubleshooting, and binding-provenance documentation public

Verification

  • pnpm docs:check
  • pnpm package:verify
  • package tarball contains only the 13 public documentation pages and no maintainer procedures
  • clean TypeScript consumer passed

Summary by CodeRabbit

  • Documentation
    • Added a comprehensive SDK delivery checklist covering package, documentation, examples, and release acceptance readiness.
    • Updated release guidance to reference the new checklist.
    • Refined onboarding guidance to highlight troubleshooting and versioning before SDK upgrades.
    • Streamlined documentation navigation by removing outdated publishing, release, and delivery checklist links.
    • Removed the SDK delivery checklist from the main README’s guide list.

@coderabbitai

coderabbitai Bot commented Jul 26, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 1f457497-2514-47b2-a5ca-34f51557cf92

📥 Commits

Reviewing files that changed from the base of the PR and between c722ee9 and 5ab8b1a.

📒 Files selected for processing (6)
  • .github/maintainers/gitbook-publishing.md
  • .github/maintainers/sdk-delivery-checklist.md
  • .github/maintainers/sdk-releasing.md
  • README.md
  • docs/README.md
  • docs/SUMMARY.md

📝 Walkthrough

Walkthrough

Adds an SDK delivery checklist, updates maintainer release references to use it, and revises public documentation links and upgrade guidance.

Changes

SDK release documentation

Layer / File(s) Summary
SDK delivery checklist
.github/maintainers/sdk-delivery-checklist.md
Adds package, documentation, example, and release-acceptance criteria, with a delivery gate requiring all release-acceptance items to be checked.
Maintainer checklist references
.github/maintainers/gitbook-publishing.md, .github/maintainers/sdk-releasing.md
Updates publishing and stable-release instructions to reference sdk-delivery-checklist.md.
Public documentation navigation
README.md, docs/README.md, docs/SUMMARY.md
Removes obsolete delivery and release links and replaces upgrade guidance with troubleshooting and versioning guidance.

Estimated code review effort: 1 (Trivial) | ~5 minutes

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/public-content-boundary

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@Utilitycoder
Utilitycoder merged commit 1463bfe into main Jul 26, 2026
3 of 4 checks passed
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