Automattic / Automattic/jetpack
[Boost] Write documentation for Boost Cache
- Dominant language
- PHP
- Stars
- 1.8k
- Forks
- 898
- Avg merge
- 1d 18h
- Merged PRs (30d)
- 774
Description
This can be tackled after we release an internal beta, while we wait for feedback and prepare for launch.
There is a growing list of "Learn More" links throughout Boost Cache's UI. We need to write a documentation page, or multiple pages that address them all.
- [ ] On the error messages that can appear on the Boost dashboard when setup fails
- [ ] On the "Exceptions" list configuration
Contributor guide
Research direction
Start from the Boost Cache UI's growing list of “Learn More” links and identify the linked setup-failure error messages and the “Exceptions” list configuration. Review the existing Boost Cache documentation structure before choosing one page or multiple pages. Done means each listed link has documentation covering its topic and the pages are ready for launch feedback.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100