Skip to content

docs: add CLAUDE.md, the working contract for this submodule - #1

Open
meodemsao wants to merge 1 commit into
mainfrom
chore/docs-claude-md
Open

docs: add CLAUDE.md, the working contract for this submodule#1
meodemsao wants to merge 1 commit into
mainfrom
chore/docs-claude-md

Conversation

@meodemsao

Copy link
Copy Markdown

Adds CLAUDE.md to this submodule — the repo-specific half of the working contract. The repo-wide process (Superpowers + Plane) stays in the control repo; this file carries only what is specific to docs.

What it covers

  • Layout and commands — Astro Starlight, docs.veilus.io, npm run dev|build|preview.
  • Scope boundary — this is user documentation. Architecture, specs, plans and decisions live in project-docs/ in the private control repo and must not be copied here.
  • Two consequences of this repo being public:
    1. Never register the self-hosted runner for this repo. It is scoped to veilus/veilus on purpose — a pull request from any fork would otherwise run arbitrary code on a personal machine.
    2. Documentation describes what a feature does, not which patch touches which API. Fingerprint internals stay in the private chromium/ submodule.
  • Docs track the released product, not the branch in progress.
  • Double commit — submodule first, then the pointer in the control repo.

Why a PR rather than a push

main is protected here. The commit (b954636) already exists locally and is referenced by the control repo's submodule pointer, so until it is reachable on origin a fresh clone with --recurse-submodules cannot resolve docs. Merging this closes that gap.

🤖 Generated with Claude Code

https://claude.ai/code/session_015kkTauhgGYW6zC4hgVEj4Y

The repo-wide process lives in the control repo; this file carries what an
agent needs that is specific to docs — layout, commands, the traps that have
already cost time here, and the boundaries this repo must not cross.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
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