Add docs/ folder, CLAUDE.md, and streamline README #584
Conversation
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
Dev to Main December 2025
Reorganize documentation into dedicated guides (architecture, API reference, development, testing, deployment, collectors) so cross-cutting topics are discoverable without duplicating the existing per-module READMEs. Slim the root README down to a quick-start and doc index. Add CLAUDE.md for AI-assisted development context. Add .vscode/ to .gitignore. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
|
| GitGuardian id | GitGuardian status | Secret | Commit | Filename | |
|---|---|---|---|---|---|
| 15086721 | Triggered | Generic Password | 5de5f98 | .github/workflows/test_app.yml | View secret |
🛠 Guidelines to remediate hardcoded secrets
- Understand the implications of revoking this secret by investigating where it is used in your code.
- Replace and store your secret safely. Learn here the best practices.
- Revoke and rotate this secret.
- If possible, rewrite git history. Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data.
To avoid such incidents in the future consider
- following these best practices for managing and storing secrets including API keys and other credentials
- install secret detection on pre-commit to catch secret before it leaves your machine and ease remediation.
🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.
josh-chamberlain
approved these changes
Feb 11, 2026
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
docs/folder with six cross-cutting guides: architecture, API reference, development, testing, deployment, and collectorsREADME.mdto a quick-start and documentation index table, moving detailed content intodocs/CLAUDE.mdwith project context for AI-assisted development (tech stack, key commands, architecture patterns, conventions).vscode/to.gitignoreExisting per-module READMEs (39+) are untouched — the new docs complement them by covering topics that span multiple modules.
Test plan
🤖 Generated with Claude Code