docs: rename docs/ to Docs/ and make it read-only for agents#9
Merged
Conversation
Rename the documentation directory docs/ -> Docs/ to match the project's capitalized top-level layout (OpenAppLock/, Shared/, Config/), and update every reference in AGENTS.md, CLAUDE.md, CONTRIBUTING.md, and README.md. Add a Documentation rule to AGENTS.md: Docs/ is human-authored reference material that agents read for context but must never create or modify. The goal is for all documentation to be human-written; only AGENTS.md and CLAUDE.md are agent-maintained. Reframe the TDD guidance so agents consult the feature spec rather than editing it, and flag needed spec changes to the maintainer instead. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Rename Docs/RULES_FEATURE_SPEC.md and Docs/SWIFT_GUIDELINES.md to AGENT_-prefixed names and switch the documentation policy from directory-based (everything under Docs/ is read-only) to filename-based: - AGENT_-prefixed files (plus AGENTS.md, CLAUDE.md) are agent-managed — agents may read, create, and edit them and keep them current. - All other docs (README.md, CONTRIBUTING.md, future human-authored docs) remain read-only to agents. The prefix is the contract, so newly added human docs are off-limits by default. Updates all cross-references in AGENTS.md, CLAUDE.md, CONTRIBUTING.md, README.md, and the spec link inside the guidelines file. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
docs/→Docs/to match the project's capitalized top-level layout (OpenAppLock/,Shared/,Config/). Both files (RULES_FEATURE_SPEC.md,SWIFT_GUIDELINES.md) move as tracked renames.AGENTS.md,CLAUDE.md,CONTRIBUTING.md, andREADME.md.AGENTS.md:Docs/is human-authored reference material — agents read it for context but must never create or modify any file under it. The eventual goal is for all documentation to be human-written; onlyAGENTS.mdandCLAUDE.mdare agent-maintained.Docs/.CONTRIBUTING.md's "update the spec first" instruction is intentionally left intact (path only) — that doc addresses human contributors, for whom authoring the spec is correct.Test plan
git grep "docs/"returns no lowercase path references (verified locally)README.md,CONTRIBUTING.md,CLAUDE.mdresolve toDocs/…docs/path (docs-only change; no build/test impact)🤖 Generated with Claude Code