mirror of
https://github.com/runbear-io/beardrive.git
synced 2026-08-25 08:08:08 +02:00
b10c6f961e
Adds web/docs — the public product documentation, built with Astro + Starlight and deployed on its own rather than embedded in the binary. Why a standalone site in the OSS repo, rather than a section of the cloud landing page: - Docs change far more often than the binary does. Embedding them would mean a Go rebuild and redeploy to fix a typo, and would ship a Pagefind search index inside every self-hoster's install. - Self-hosting instructions and the CLI reference document the OSS project, so "edit this page" should resolve to something an outside contributor can open a PR against. - Design tokens get easier, not harder: scripts/tokens.mjs generates src/styles/tokens.gen.css from the @theme block in the hub frontend's tw.css, so there is one source of truth and nothing to police. (The cloud landing sits across a module edge and has to keep a *copy*, guarded by its own check-tokens.mjs.) custom.css maps Starlight's --sl-color-* onto those tokens and invents no colors of its own. Content is seeded from README.md, docs/self-hosting.md, and the plugin skill. Guides deliberately cover agent workflows — connecting an agent, the two-file AGENTS.md orientation pattern, artifacts and links, read heat, scoping the folder — rather than re-teaching the CLI, which lives in Reference. starlight-llms-txt emits /llms.txt at build. Convention wants that at the root domain, so beardrive.ai/llms.txt should point here; that redirect belongs to the cloud landing and is the one cross-repo coordination point this split introduces. Claude-Session: https://claude.ai/code/session_018GcqsM6prjdv9rUrhVVEiC Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
17 lines
371 B
JSON
17 lines
371 B
JSON
{
|
|
"name": "beardrive-docs",
|
|
"private": true,
|
|
"type": "module",
|
|
"scripts": {
|
|
"dev": "npm run tokens && astro dev",
|
|
"build": "npm run tokens && astro build",
|
|
"preview": "astro preview",
|
|
"tokens": "node scripts/tokens.mjs"
|
|
},
|
|
"dependencies": {
|
|
"@astrojs/starlight": "^0.41.3",
|
|
"astro": "^7.1.1",
|
|
"starlight-llms-txt": "^0.11.0"
|
|
}
|
|
}
|