Skip to content

docs: move architecture reference to docs/ARCHITECTURE.md, untrack CLAUDE.md (ADR-017)#28

Merged
tikankika merged 2 commits into
mainfrom
chore/adr-017-claude-md-exclusion
Jul 7, 2026
Merged

docs: move architecture reference to docs/ARCHITECTURE.md, untrack CLAUDE.md (ADR-017)#28
tikankika merged 2 commits into
mainfrom
chore/adr-017-claude-md-exclusion

Conversation

@tikankika

Copy link
Copy Markdown
Owner

Summary

Per ACDM ADR 017 (.claude/ and agent-instruction files are local dev-tooling, out of the public artefact), teaching-suite was the last public repo in the family still shipping its root CLAUDE.md. QuestionForge and Assessment Suite never tracked theirs; edusafe excludes it at flip.

  • docs/ARCHITECTURE.md — the architecture and full tool reference, moved to a conventional human-facing home (git detects the rename, 89% similar; agent framing dropped, content carried over at v0.6.0 state)
  • CLAUDE.md — untracked and gitignored (/CLAUDE.md, root-anchored); remains on disk locally as a thin pointer importing docs/ARCHITECTURE.md, so agent sessions and public readers share one source of truth
  • All references updated: README's developer door and docs list, TEACHER_GUIDE, EXAMPLES_POLICY scope list, examples/README language note, methodology/shared_principles
  • CHANGELOG entry under Unreleased

Verification

  • Full test suite green (657), including the process-name guard over the touched docs
  • git grep confirms no remaining tracked links to the root CLAUDE.md

🤖 Generated with Claude Code

tikankika and others added 2 commits July 7, 2026 13:51
…AUDE.md (ADR-017)

Per ACDM ADR-017, agent-instruction files are local dev-tooling and stay
out of the public artefact. Teaching-suite was the last public repo in
the family still shipping its root CLAUDE.md.

- docs/ARCHITECTURE.md: the architecture and tool reference, now in a
  conventional human-facing home (content carried over, agent framing
  dropped)
- CLAUDE.md untracked (git rm --cached) and gitignored (/CLAUDE.md,
  root-anchored); it remains on disk locally as a thin pointer that
  imports docs/ARCHITECTURE.md
- All references updated: README's developer door and docs list,
  TEACHER_GUIDE, EXAMPLES_POLICY scope list, examples/README language
  note, methodology/shared_principles

Full test suite green (657), including the process-name guard over the
touched docs.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…TURE.md

Records the decision, the alternatives considered (keep public /
documented exception / exclude and relocate), and the consequences.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@tikankika tikankika merged commit 62350a8 into main Jul 7, 2026
5 checks passed
@tikankika tikankika deleted the chore/adr-017-claude-md-exclusion branch July 7, 2026 11:54
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