Repository navigation
Closed
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or request
Description
Problem
The current quickstart documentation has two approaches (Docker Desktop UI vs. standalone sbx CLI) commingled throughout, causing confusion for users. Assessment participants and first-time users struggle to understand which instructions apply to them.
Key Issues Identified
- Conflicting recommendations: Lines 52 and 128 both say "Recommended" for different methods
- Interleaved instructions: Users must mentally filter which steps apply to their chosen method
- Missing secret management:
sbx secretbarely documented (only in tables) - No decision tree: Users must read everything to pick a method
- Terminology inconsistent: "Docker Sandboxes" vs "Docker sandbox" vs "SBX"
- README too long: 366 lines with both paths mixed together
Proposed Solution
1. Make sbx CLI the Recommended Path
- Better for federal automation and audit trails
sbx secretprovides secure keychain-backed credential storage- Policy controls more granular
- Aligns with infrastructure-as-code principles
2. Restructure Documentation
Lean README.md (~150 lines):
- Brief intro and ecosystem context
- 5-minute quickstart (sbx CLI, copy-paste commands)
- Link to full quickstart guide for details
- Link to Docker Desktop alternative
New docs/QUICKSTART_SBX.md:
- Full sbx CLI setup with secret management
- USAi-focused configuration
- Detailed explanations
New docs/QUICKSTART_DOCKER_DESKTOP.md:
- Docker Desktop UI approach
- For users who prefer GUI
- Clear that this is the alternative path
Updated docs/SBX_QUICKSTART.md:
- Rename or consolidate with new structure
- Comprehensive reference (keep 907 lines)
3. Add Secret Management Documentation
- Full tutorial on
sbx secret set/ls/rm - Comparison:
sbx secretvs shell export - Supported services table
- Non-interactive setup for CI/CD
4. Add Decision Tree
- Clear guidance on when to use each method
- Federal compliance considerations
Implementation Plan
- Create lean README.md with 5-minute quickstart
- Create docs/QUICKSTART_SBX.md (primary path)
- Create docs/QUICKSTART_DOCKER_DESKTOP.md (alternative)
- Add secret management sections to both guides
- Update cross-references in existing docs
- Fix terminology inconsistencies
- Update KNOWN_FAILURE_MODES.md if needed
Success Criteria
- First-time user can get working sandbox in <5 minutes
- Clear guidance on sbx CLI vs Docker Desktop
sbx secretfully documented- No conflicting "Recommended" labels
- Terminology consistent throughout
- Assessment participants have clear path
Research Completed
- Analyzed current README.md (366 lines, 17 sections)
- Analyzed docs/SBX_QUICKSTART.md (907 lines)
- Researched Docker official docs (https://docs.docker.com/ai/sandboxes/)
- Documented full sbx CLI command reference
- Identified 10 major confusion points
Related
Based on assessment participant feedback and user journey analysis.
Control Mapping: SA-5 (System Documentation)
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or request
Activity
docs: restructure quickstart with sbx cli as primary path (#42)
fix(ci): unblock unrelated PRs from the bash32 required-check deadlock (