Skip to content

A docs site, on Nimbus, from the README and operating.md - #6

Merged
nuandy merged 1 commit into
devfrom
docs-site
Oct 15, 2026
Merged

nuandy merged 1 commit into
devfrom
docs-site

Conversation

@alsey89

@alsey89 alsey89 commented Oct 15, 2026

Copy link
Copy Markdown
Collaborator

Why

Everything about using and running GitHive is in one 286-line README plus docs/operating.md. A docs site splits that into pages with a sidebar, search, light and dark themes, and a Markdown version of every page plus /llms.txt for agents.

What changed

  • docs-site/: a Nimbus site, Cloudflare's docs framework on Astro, made with create-nimbus-docs (static output, Cloudflare target). It has its own package.json and wrangler.jsonc (Worker githive-docs), so the root build and tests don't change.
  • 18 pages, taken word for word from the README's and operating.md's sections:
    • Introduction, Get started, How it works, Built on Cloudflare, Concepts
    • Reference: GitHub, MCP tools, Command line, Merge checks, Language support
    • Run your own: Signing in, Data and security, Deploy your own, Run it locally, Develop
    • Benchmarks, Known gaps, How this was built
  • Links: links between sections point at their pages. Links to docs/design.md, awareness.md, github-prs.md, dashboard-ui.md, cli/, scripts/ and bench-results/ point at GitHub.
  • Screenshots: the hive and architecture images follow the site's light/dark toggle (two rules in prose.css).
  • MCP tools: the list is a table instead of a fixed-width text block that got cut off.
  • Formatting: docs-site is in .prettierignore, since Nimbus's files use two-space indents and the root style uses tabs.

Not in this PR

  • No deploy. The site URL https://docs.githive.app (in docs-site/astro.config.ts) is a placeholder until a domain is chosen. Deploying is cd docs-site && npm run deploy, plus a routes entry for the domain.
  • The README stays the source. The site is a copy, so the two drift until one becomes the source.
  • The design docs aren't pages, only linked.

Test plan

  • npm run build in docs-site/: 18 pages built, 18 indexed for search
  • npx @cloudflare/nimbus-docs check: Ready
  • npm run typecheck (astro check): 0 errors, 0 warnings, 0 hints
  • All 342 internal links on the 18 pages in the sitemap return 200
  • Screenshots in light, dark and at 390px wide: images switch with the theme, and "edit this page" opens the right file
  • Root prettier --check . reports nothing in docs-site/

🤖 Generated with Claude Code

docs-site/ is a Nimbus (Astro) site that builds to static files for its own Worker, githive-docs. Its 18 pages are
the README's and operating.md's sections, word for word, one page each: links between sections point at their pages,
links to the design docs, scripts and bench results point at GitHub, the hive and architecture screenshots follow
the site's light/dark toggle, and the MCP tools list is a table. Nothing is deployed yet, and the site URL,
docs.githive.app, is a placeholder until a domain is chosen. The root's prettier skips docs-site, which keeps
Nimbus's own formatting.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
@nuandy
nuandy merged commit 9c99c98 into dev Oct 15, 2026
1 check passed
@nuandy

nuandy commented Oct 15, 2026

Copy link
Copy Markdown
Owner

Thanks for this, it's merged! The site is now the source of the docs, so I followed up in 4cf9c91:

  • The README is down to the pitch, both images, Try it, the five steps, the numbers and links to every page.
  • docs/operating.md is a pointer that keeps its three headings, so links to its anchors (the sign-in page's "Your data") still land.
  • Links in docs/awareness.md, bench-results/README.md and .dev.vars.example point at the pages.
  • "Edit this page" opens dev, since main is protected and only moves to tested dev commits.

The domain and deploy come later.

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.

2 participants