Skip to content

feat(website): Appduct docs site on Astro Starlight - #77

Merged
V3RON merged 5 commits into
claude/jolly-wozniak-e5icq4from
feat/website
Sep 21, 2026
Merged

V3RON merged 5 commits into
claude/jolly-wozniak-e5icq4from
feat/website

Conversation

@V3RON

@V3RON V3RON commented Sep 21, 2026

Copy link
Copy Markdown
Contributor

Adds a docs and landing site for Appduct in a new website workspace package. It's built with Astro 7 and Starlight 0.42, styled after the Callstack slide theme, and deployed to GitHub Pages at https://callstackincubator.github.io/appduct/.

What's in it

  • Landing page (website/src/pages/index.astro): built on Starlight's page component, so the header, search and theme toggle match the docs. Its sections follow the keynote decks: large light headlines with an accent second line, uppercase mono labels, hairline dividers, square corners and a full-width purple band.

  • Docs: 15 pages in four sidebar groups:

    • Start here: introduction, quick start, playground.
    • Installation: React Native, iOS, Android. Each page ends with next steps (writing tools, agents, the CLI, verifying release builds).
    • Guides: agents, CLI, writing tools, build variants, security.
    • Reference: CLI, React Native API, how it works, wire protocol.

    They're written in the user-facing docs style from the existing READMEs and docs/, and CLI flags and APIs were checked against the source. They reflect refactor(mcp)!: make elicitation the only "prompt" consent channel #73, feat: tool groups — optional group on the descriptor and --group/--groups on tools.list #74 and feat(mcp)!: reach app tools through list/describe/call built-ins #75: elicitation consent, tool groups, and the list/describe/call built-ins.

  • Theme: dark by default, with the toggle kept. Code blocks use the theme's token colours. Fonts are self-hosted: Switzer (Fontshare) and Geist Mono (@fontsource/geist-mono). Alliance No. 2 is left out on purpose because it's a commercial font and this repo is public.

  • For LLMs:

    • llms.txt is a curated index linking every page's raw Markdown.
    • llms-full.txt and llms-small.txt come from starlight-llms-txt.
    • There are also getting-started and reference bundles.
    • Every page is available as <page>.md.
    • Each page's head has a <link rel="alternate" type="text/markdown"> tag.
    • The site has a sitemap.
  • Links validation: starlight-links-validator checks internal docs links and anchors at build time. scripts/check-md-links.mjs now skips website/src/content, because it can't resolve Starlight's URL-style links.

  • Deploy (.github/workflows/website.yaml): PRs build and typecheck the site; pushes to main deploy it. The pnpm and Node setup matches lint.yaml, and the actions are pinned by SHA.

Screenshots

Landing, desktop Landing, mobile
Docs, dark Docs, light

Notes for reviewers

  • Before the first deploy, set the repo's Settings → Pages → Source to GitHub Actions.
  • Lockfile: pnpm install also bumped two existing resolutions: the MCP SDK's zod peer from 4.4.3 to 4.6.5, and vitest's @types/node from 22 to 24. pnpm --filter appduct test passes (739 passed, 1 skipped).
  • robots.txt is served under /appduct/, so crawlers won't read it. It's harmless.
  • Docs drift: while writing the docs I found several places where the repo docs no longer match the code. The website follows the code; the repo docs are left for a follow-up:
    • The README still says MCP app tools show up next to the agent's own.
    • The --scheme help text leaves out native project files as a source.
    • TOOLS.md documents a defaultToolTimeoutMs option that no longer exists.
    • SECURITY.md and BUILD-VARIANTS.md disagree about the Android release swap.
  • Not verified: the Pages workflow hasn't run on GitHub yet.
  • Screenshots are stored on the pr-assets/website branch. Delete it after merge.

@V3RON
V3RON changed the base branch from main to claude/jolly-wozniak-e5icq4 September 21, 2026 14:17
@V3RON
V3RON added this pull request to stack #79 September 21, 2026 14:22
@V3RON
V3RON merged commit 2d6dd39 into main Sep 21, 2026
7 checks passed
@V3RON
V3RON deleted the feat/website branch September 21, 2026 14:24
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