Skip to content

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

Merged
f0rr0 merged 7 commits into
mainfrom
f0rr0/rewrite-developer-docs
Sep 30, 2026
Merged

f0rr0 merged 7 commits into
mainfrom
f0rr0/rewrite-developer-docs

Conversation

@f0rr0

@f0rr0 f0rr0 commented Sep 8, 2026 •

Copy link
Copy Markdown
Owner

Summary

Rewrite the developer docs around choosing an SDK, installing its prerequisites, running a complete query, and building an application. Review all 42 authored pages and the root plus seven SDK READMEs against current main (32ce7b29510b74333e799601b69a71fd28122e80), keeping 44 documentation routes available.

  • Use a restrained dark default inspired by f0rr0.dev, GPU Postal and mealprep.party: DM Sans prose and section headings, Instrument Serif page titles, and consistent 256/768/224px layout columns. Replace the old mascot with an open O mark and monochrome engraving; reuse the mark in the favicon and social cards. Align SDK names with the reading column and use measured 80px rows. Retain light mode and keyboard skip navigation; reuse Fumadocs/Tailwind primitives.
  • Keep guides and API references visible, fix static search and Markdown exports, and shorten the start-page introduction so readers reach SDK selection sooner.
  • Correct current integration requirements: mobile seed resources and broker setup, typed extension descriptors, native restore destinations, Deno initialization permissions, and the separate WASIX PostgreSQL server package. Remove superseded native 0.2 workarounds and defect notices.
  • Resolve install versions from the central release manifest so examples stay paired with checkout APIs. List completed releases separately and export docs-version.json with source revision, dirty state and product versions for archived builds.
  • Add a local documentation skill, primary-source research and a file-by-file audit. Apply better-writing and keep maintainer procedures and design rationale outside the public developer path.
  • Keep documentation-only SDK edits from requesting package releases through directory ownership. Preserve release impact for declared changelogs, explicit shared inputs and mixed source changes.
  • Type-check TypeScript quickstarts in the production build and validate exported links, anchors, search, Markdown coverage and version substitution. Serialize the smoke reader with generation so concurrent local checks cannot temporarily remove its route metadata.

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 API and versions. Completed releases may lag that target; their availability does not select the version shown on a newer API example. No runtime behavior, package version, or platform support floor changes.

Verification

  • Moon docs check, test, format, lint and test-package passed with pinned Moon 2.5.4: 44 documentation routes and 49 exported HTML files.
  • Frozen Bun installation, platform compatibility policy tests, local skill validation and diff whitespace check passed.
  • Native Rust and WASIX Rust first-query examples compiled as external consumers against current source; C passed strict syntax checking against the current header; three TypeScript quickstarts passed strict source type-checks.
  • Production screenshots reviewed on desktop and mobile in light/dark themes. All 44 routes passed a 320px overflow/H1/main-landmark/token audit. Shared content edges, title alignment and row rhythm were measured at seven widths from 320px to 1920px. Keyboard tabs, skip link, theme selection, mobile sidebar, code copy and Copy Markdown passed browser checks.
  • Axe reported no WCAG A/AA violations on seven page/viewport/theme samples; measured text contrast passes AA in both themes. The separately tested open search has an inherited Fumadocs aria-selected warning on result buttons; a dependency change is outside this visual iteration. Full screen-reader testing was not performed.

SDK runtime execution, Apple/Android device builds and full product packaging qualification were not performed in this pass. Source review and compilation are reported separately from execution. Historical published-package experiments remain dated records and do not certify the current release set.

See the current per-file audit for findings and validation boundaries, and the authoring guide for version and snapshot maintenance.

@vercel

vercel Bot commented Sep 8, 2026 •

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 29, 2026 8:27pm UTC

@f0rr0
f0rr0 merged commit d2541ff into main Sep 30, 2026
92 checks passed
@f0rr0
f0rr0 deleted the f0rr0/rewrite-developer-docs branch September 30, 2026 23:16

This branch was successfully deployed

1 active deployment
Preview — 2cc4b1d3 Deployed Sep 29, 2026 by vercel[bot]
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