Commit 2fea495
Add comprehensive documentation to scripts/bootstrap.py
Enhanced the bootstrap script with detailed comments and docstrings:
Documentation Added:
- Enhanced module-level docstring with complete bootstrap process (7 steps)
- Added detailed feature descriptions and error handling notes
- Documented all utility functions with comprehensive docstrings:
- check_infrahub_ready(): Infrahub API readiness checking
- run_command(): Shell command execution with visual feedback
- wait_for_repository_sync(): Repository synchronization wait
- main(): Primary bootstrap orchestrator with 11-step sequence
- Added section headers throughout the file:
- Configuration and Setup
- Utility Functions
- Command-Line Interface
- Added inline comments explaining:
- Rich UI component configuration
- Bootstrap step execution logic
- Repository addition with graceful failure handling
- Event actions loading (optional step)
- Command-line argument parsing
Each function now includes:
- Purpose and context explanation
- Visual feedback descriptions
- Args and Returns documentation
- Usage examples
- Implementation notes
This documentation helps developers understand the complete bootstrap
workflow and how each component contributes to setting up Infrahub.
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude <noreply@anthropic.com>1 parent b9b0dbd commit 2fea495
1 file changed
+290
-37
lines changed
0 commit comments