Add comprehensive documentation and docstrings#31
Open
jscrobinson wants to merge 2 commits intomainfrom
Open
Conversation
- Rewrite README with detailed usage documentation including: - Storage architecture explanation (S3, SSM, Secrets Manager) - Value retrieval and flattening process - Configuration merging behavior - CLI command reference with examples - Redis auto-allocation documentation - Programmatic usage examples - AWS permissions and troubleshooting - Add docstrings to bootstrap.py classes: - BootstrapParameters, BootstrapApp, BootstrapEnvironment, BootstrapManager - Document all public methods with Args/Returns - Add docstrings to redis_config.py: - Module and class documentation - Database allocation/deallocation methods - Add docstrings to cli.py: - Module-level documentation - Command help text improvements 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Explain how secrets are tagged with Environment and App metadata and how these tags are used for filtering during retrieval. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.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.
Summary
bootstrap.py,cli.py, andredis_config.pyChanges
README.md
Code Documentation
bootstrap.py: Docstrings for BootstrapParameters, BootstrapApp, BootstrapEnvironment, BootstrapManager and all methodsredis_config.py: Module and class documentation for Redis database allocationcli.py: Module-level documentation and command help textTest plan
croudtech-bootstrap --help)🤖 Generated with Claude Code