Restructure docs: overview README, technical reference, ops runbook - #17
Merged
Merged
Conversation
README.md now leads with what TagManager is, capabilities, and use cases, with a TOC linking out. Technical content (CLI flags, exit codes, config reference) migrated to docs/technical-reference.md; new docs/runbook.md covers deploy, credentials, scopes, monitoring, and incident response. README.txt retired; pyproject and Dockerfile updated to reference README.md. 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
2 participants
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
README.md— what TagManager is, capabilities, how it can be used, quick start, and a documentation TOCdocs/technical-reference.md— migrated technical content from README.txt (CLI usage, CSV gold-list/S3, exit codes, full config reference, dev setup)docs/runbook.md— full ops runbook: deploy, per-cloud credentials, adding scan scopes, rules management, manual scans, monitoring, incident table, backup/restore, known limitspyproject.tomlreadme field and Dockerfile COPY updated to README.mdTest plan
pip install -e ".[dev]"parses the new readme field cleanly🤖 Generated with Claude Code