[EPIC] Revamp Quick Start Guide and Improve Docs Structure
Open
Nobody has claimed this yet.
area/docs
epic
- Dominant language
- Go
- Stars
- 1.4k
- Forks
- 364
- Avg merge
- 1d 4h
- Merged PRs (30d)
- 84
Description
Description
The Quick Start guide is the first impression for new users, but it can be more efficient, clear, and engaging. We also see opportunities to improve the overall structure of the docs so users can better navigate and understand PipeCD’s complexity.
Goals
- Make Quick Start easier and faster to follow.
- Cover core concepts
- Improve navigation and organization across docs.
- Ensure technical depth for advanced users while keeping the quick start "quick"
Discussion Prompt
- How can we simplify Quick Start without losing depth?
- What structural improvements would help you (or others) find information faster?
- How can we make sure that the quick start is more 'new contributor' friendly?
Drop your comments below!
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the existing Quick Start guide and the overall documentation navigation to identify the current flow, core concepts, and structural gaps. Define a focused proposal for making Quick Start faster while preserving technical depth; done should include clearer navigation and an agreed scope for the documentation changes.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100