Skip to content

docs(rfc): RFC-0037 cloudhal.dev, the developer site - #34

Merged
Madraka merged 2 commits into
mainfrom
docs/rfc-0037-cloudhal-dev
Oct 20, 2026
Merged

Madraka merged 2 commits into
mainfrom
docs/rfc-0037-cloudhal-dev

Conversation

@Madraka

@Madraka Madraka commented Oct 20, 2026

Copy link
Copy Markdown
Contributor

Draft RFC for the full cloudhal.dev, following the stopgap in #33.

  • Stack: Astro Starlight in apps/docs, reading the repo's docs/ directly, so docs keep changing in the same PR as code. Reference pages (CLI, MCP tools, config, schemas, changelog) are generated.
  • Link contract: published URLs never break (301s from a redirect table), /schemas/v1 is permanent, user-facing links go to cloudhal.dev rather than GitHub paths, /e/<code> pages for errors, CI checks it all.
  • Docs for agents: .md per page, Accept: text/markdown, llms.txt/llms-full.txt per section, a read-only MCP at cloudhal.dev/mcp and search_docs/read_doc in cloudhal mcp.
  • Phases 1–4 and three open questions at the end.

🤖 Generated with Claude Code

Madraka and others added 2 commits October 21, 2026 01:29
Starlight in apps/docs over the repo's docs/, a link contract checked in
CI, error-code pages, and docs for agents (.md per page, content
negotiation, llms.txt, a read-only docs MCP and search_docs in
cloudhal mcp).

Co-Authored-By: Claude Opus 5.5 <[email protected]>
Signed-off-by: Madraka <[email protected]>
Open questions decided as recommended: every ADR and RFC is published
with its status, error codes live in one registry in core-contracts,
and the docs MCP waits for a registry.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
Signed-off-by: Madraka <[email protected]>
@Madraka
Madraka merged commit 09cbaba into main Oct 20, 2026
4 checks passed
@Madraka
Madraka deleted the docs/rfc-0037-cloudhal-dev branch October 21, 2026 11:33
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