Skip to content

docs: a real usage site (#89) - #63

Merged
dwikiriyadi merged 2 commits into
mainfrom
docs/89-usage-site
Nov 10, 2026
Merged

dwikiriyadi merged 2 commits into
mainfrom
docs/89-usage-site

Conversation

@dwikiriyadi

Copy link
Copy Markdown
Member

Summary

docs/usage was a single "not released yet" page. It is a documentation site now.

  • 21 pages: getting started (installation, a quick start on the sample list screen), how the layers fit together, one page per module (11), three guides (testing, a production setup, paging with Camouflage), a changelog, an FAQ and links. Every sample has a Kotlin and a Dart tab.
  • Offline search, as on Camouflage's site.
  • Real samples. A // sample: <path>#<region> block is copied from a compiled or analyzed file in the libraries by scripts/sync_samples.py, which also fails on a block that has drifted. The Kotlin ones come from kotlin-lib/sample/docs, a module CI compiles and tests.
  • Two fixes from Camouflage's #69: the language switch now drives every Kotlin/Dart code group (the scaffold's LangTabs ignored it, so the switch changed nothing on a page), and the home page language menu is no longer clipped.

Testing

Check Result
npm run build Succeeds, with onBrokenLinks: 'throw'
Language switch, in the browser Every tab group follows the sidebar switcher, and a tab click updates the saved choice
sync_samples.py --check 31 blocks, none out of date; a changed sample is caught by name
The pages' claims Status table, paging mapping and Android notes were checked against the code

For review

  • GitNexus detect-changes reports critical risk and 422 affected processes. It's a false positive. The staged change is the site (pages, a script, three UI components, a config). The one symbol that links to flows is the themes property in docusaurus.config.ts, which name-matches unrelated code symbols called themes; the graph is also stale (last indexed at 56113d8). No library runtime code is in this PR.
  • The paths in the sample blocks (kotlin-lib/..., dart-lib/...) resolve through the submodules. Until Dependabot bumps the submodule pointers after the library PRs merge, --check can't find the new files in CI, so I haven't added it to CI yet.
  • As before, the App Services pages (ADR-27) stay uncommitted for their own PR.

Closes srctool/sinew-kotlin#89

Pairs with the samples in srctool/sinew-kotlin (docs/89-doc-samples) and the region markers in srctool/sinew-dart (docs/86-dart-doc-samples).

🤖 Generated with Claude Code

dwikiriyadi and others added 2 commits November 10, 2026 10:53
docs/usage was a single "not released yet" page. It is now a documentation
site: getting started (installation, a quick start on the sample list screen),
how the layers fit together, one page per module, guides (testing, a
production setup, paging with Camouflage), a changelog, an FAQ and links, with
offline search.

Every sample is real code. A `// sample: <path>#<region>` block is copied from
a compiled or analyzed file in the libraries by scripts/sync_samples.py, which
also fails on a block that has drifted.

The language switch now drives every Kotlin/Dart code group (the scaffold's
LangTabs ignored it), and the home page language menu is no longer clipped:
both fixes are Camouflage's (srctool/camouflage#69).

Closes srctool/sinew-kotlin#89

Co-Authored-By: Claude Sonnet 5.5 <[email protected]>
@dwikiriyadi
dwikiriyadi merged commit 4057e5c into main Nov 10, 2026
4 checks passed
@dwikiriyadi
dwikiriyadi deleted the docs/89-usage-site branch November 10, 2026 06:50
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.

Usage docs: the site and the Kotlin pages

1 participant