Skip to content

Navigation Menu

Sign in
Sign up

docs: rewrite developer guides and simplify the documentation site - #205

Open
f0rr0 wants to merge 4 commits into
main from
f0rr0/rewrite-developer-docs
Open

docs: rewrite developer guides and simplify the documentation site #205
f0rr0 wants to merge 4 commits into
main from
f0rr0/rewrite-developer-docs

Conversation

@f0rr0

@f0rr0 f0rr0 commented Sep 8, 2026
edited
Loading

Copy link
Copy Markdown
Owner

Summary

Rewrite the developer documentation around choosing an SDK, installing it, running a complete parameterized query, and keeping data between runs. Reorganize all 41 authored public pages and the root plus seven SDK READMEs into quickstarts, task guides, and API reference, with examples and lifecycle constraints checked against the current checkout.

  • Replace the decorative landing page and oversized styling with a consistent Fumadocs layout, simpler navigation, responsive SDK chooser, and readable light/dark themes. Fix static search and Markdown exports.
  • Resolve installation versions from existing release metadata and emit docs-version.json with the source revision and product/version set. Document clean-commit snapshots for independently released SDKs; keep release synchronization from rewriting MDX tokens.
  • Add a repository-local documentation skill, primary-source research, and a file-by-file audit. Keep maintainer procedures outside public integration docs.
  • Correct release selection so documentation-only edits under SDK paths do not request package releases; declared changelogs, explicit shared release inputs, and mixed source changes retain their release impact.
  • Add strict TypeScript quickstart checks and exported-site checks for links, anchors, search, Markdown coverage, and version substitution. Remove the unused direct motion dependency.

Release Intent

  • Package/API/runtime change: PR title uses feat:, fix:, perf:, refactor:, revert:, or a breaking !.
  • Docs/CI/repository-only change: no release intended.
  • Source/input/runtime asset change: source pins, generated metadata, and release metadata affectedness are current.

Documentation targets the checkout's APIs and package versions, assuming those versions are published. No runtime behavior, package version, or platform support floor changes.

Verification

  • Passed pnpm --dir src/docs check, build, and smoke: 44 documentation routes and 49 exported HTML files.
  • Passed moon run release-tools:unit release-tools:graph-unit using pinned Moon 2.5.4 after the release-selection fix, plus 12 focused publication-plan/release-intent tests and the earlier 19 release/version/platform tests.
  • Passed changed-file Biome checks, frozen dependency installation, local skill validation, and git diff --check.
  • Compiled native Rust and WASIX Rust quickstarts, syntax-checked C against the real header, and type-checked three TypeScript quickstarts against SDK source.
  • Reviewed production screenshots at desktop and mobile sizes in both themes. All 44 documentation routes passed a 320px page-overflow check. Exercised search/result navigation, keyboard tabs, mobile sidebar, code copying, and Copy Markdown. Dark code-comment contrast improved from 3.60:1 to 5.64:1.

Full cross-platform SDK execution was not performed: native Rust execution requires the unavailable native library, and Apple/Android examples and packaging were source-reviewed. The workspace doctor and full product packaging lanes were not run. On head c05699e31771e46c132d2384c3f64f8425c849f7, hosted Release Intent, Affected Work, and the combined Docs Build/Check/Smoke job passed in CI run 34210452406. Remaining hosted jobs are still running; the full Required/Qualified gates are not yet confirmed.

See docs/maintainers/docs-rewrite-audit.md for the per-file review and validation boundaries, and src/docs/README.md for version and snapshot authoring instructions.

Historical release validation follow-up

Retain the four legacy SDK MDX version rules for strict historical release-commit validation only. Future release synchronization continues to use centralized MDX version tokens. A regression test accepts version-only historical substitutions and rejects unrelated prose edits.

On head f3407b49cb2d50741c3e31e4ed3c45a8a679a0be, hosted Planning / Release Intent, Planning / Affected Work, and Checks / Policy passed in CI run 34212275192. Local release-tools:metadata and release-tools:unit both passed, along with 21 focused tests. Remaining build/test jobs are still running; Required/Qualified are not yet confirmed.

Published-package verification

Fresh consumer checks after publication supersede the earlier execution limitations where noted in docs/maintainers/published-docs-verification.md. WASIX TypeScript and Rust quickstarts run; TypeScript persistence, transactions, backup/restore, pgTAP, Worker execution, and logical dump/restore pass. Native Rust runs with the complete GitHub archive and explicit environment setup, now documented. Native TypeScript 0.2.0 fails fresh initialization on Linux x64 under both Node and Bun; the public docs now disclose this release defect. Swift/Kotlin/React Native versions and API sources were verified, but mobile applications and browser storage were not executed. Docs check/build/smoke pass after these corrections.

vercel Bot commented Sep 8, 2026
edited
Loading

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
oliphaunt-docs Ready Ready Preview Sep 8, 2026 9:44pm UTC

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

AltStyle によって変換されたページ (->オリジナル) /