Skip to content

docs: make project instructions self-contained#119

Merged
dangazineu merged 1 commit into
mainfrom
docs/claude-md-self-contained
Jul 10, 2026
Merged

docs: make project instructions self-contained#119
dangazineu merged 1 commit into
mainfrom
docs/claude-md-self-contained

Conversation

@dangazineu

Copy link
Copy Markdown
Contributor

The committed project instructions and one package README named private sibling repositories and pointed at their internal source paths, which only make sense to someone with access to those repos. This removes those references and reframes the surrounding prose in neutral terms so the docs read cleanly for an outside contributor cloning just this repo. No behavior or public API changes.


What changed

  • CLAUDE.md
    • "What this repo is" now frames the SDK as a client over the CodeSpar API (default endpoint api.codespar.dev) that also runs against a self-hosted runtime via baseUrl, instead of naming a private backend repo.
    • The VISION pointer is now a generic "read the project VISION" line — the private-repo link, name, and internal status/date are gone.
    • The wire-contract note keeps the 1:1 method-to-route discipline but drops the internal route path; it now says to keep the TS types, the Python package, and the backend in lockstep.
    • The Repository Map lists only the public repos, plus one neutral line noting a private managed tier serves the same session contract.
    • Package inventory and coding-convention lines reference "the backend" / "the managed backend" rather than a repo name or path.
    • Dropped a stale reference to a personal onboarding doc.
  • packages/api-types/README.md
    • "Both the backend and the dashboard import from here" no longer names the private repos.

Not touched

SDK API surface, package inventory, wire-contract discipline, publishing ceremony, tech stack, conventions, workflow, and quick commands are all intact. Docs-only; no code, tests, or public API affected.

Remove references to private sibling repositories and their internal
paths from the committed instructions so they read cleanly for an
outside contributor. The wire-contract discipline, SDK surface, and
publishing runbook are unchanged; only the private-repo names, links,
and internal route paths are dropped or reframed in neutral terms. No
behavior or public API changes.
@dangazineu dangazineu changed the title docs: make project instructions self-contained for public readers docs: make project instructions self-contained Jul 10, 2026
@dangazineu dangazineu marked this pull request as ready for review July 10, 2026 22:52
@dangazineu dangazineu merged commit ce52103 into main Jul 10, 2026
9 checks passed
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