docs(readme): visitor-first quickstart + agent docs to CLAUDE.md (DOC-17/18/19)#49
Merged
Conversation
…-17/18/19) - DOC-17: replace the '## For Claude Code' README section with a visitor-first '## Quickstart' (make dev demo mode + the real-library ingest commands that already lived in that section) so a quickstart-class heading lands in the first 60 lines. - DOC-18: move the agent contract (build entrypoint, hard guardrails, commands, definition of done) into a new CLAUDE.md; the guardrail/values prose gains a public '## Guardrails' section in the README for human readers. No content lost. - DOC-19: reword the stale '(private) code scanning' comment in scorecard.yml to reflect the repo's public reality (publish_results, id-token: write, and security-events: write were already enabled). Per DOCUMENTATION-STANDARD §9. Co-Authored-By: Claude Fable 5 <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.
Remediate the DOCUMENTATION-STANDARD §9 audience-register failures flagged by the latest conformance run:
## For Claude CodeREADME section with a visitor-first## Quickstart(make devdemo mode plus the real-library ingest commands that already lived in that section), so a quickstart-class heading lands within the README's first 60 lines.CLAUDE.md; the guardrail/values prose gains a public## GuardrailsREADME section for human readers. No content lost.(private) code scanningcomment in.github/workflows/scorecard.ymlto reflect the repo's public reality.publish_results: true,id-token: write, andsecurity-events: writewere already enabled; workflow YAML re-validated with PyYAML.Verified with
automation/conformance_check.py:readme_quickstart PASS — quickstart-class heading in the first 60 linesagent_docs_separated PASS — no agent-facing README section (CLAUDE.md/AGENTS.md present)stale_private_refs PASS — no stale 'private repo' references🤖 Generated with Claude Code