-
Notifications
You must be signed in to change notification settings - Fork 50
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationgood first issueGood for newcomersGood for newcomerspriority:mediumMedium priority issueMedium priority issue
Description
Context
Harbor Satellite needs comprehensive user documentation for adoption.
Current State
- README.md with basic info
- CLAUDE.md for development
- QUICKSTART.md exists
Expected Behavior
Documentation covering:
- Project overview and use cases
- Getting started guide (satellite + GC setup)
- Configuration reference
- API documentation for GC endpoints
- Architecture diagrams
- Troubleshooting guide
- Deployment guides (Docker, Kubernetes, systemd)
Location: docs/ directory or separate docs site
Value
- Easier adoption
- Reduced support burden
- Clear onboarding path
Changes to be Made
- Create docs/ structure
- Write getting started guide
- Document all configuration options
- Document GC API endpoints
- Create architecture diagrams
- Write troubleshooting guide
- Update README.md with links
Files to Create
docs/getting-started.mddocs/configuration.mddocs/api-reference.mddocs/architecture.mddocs/troubleshooting.mddocs/deployment/docker.mddocs/deployment/kubernetes.md
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationgood first issueGood for newcomersGood for newcomerspriority:mediumMedium priority issueMedium priority issue
Type
Projects
Status
Backlog