Build docs for PRs
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 206
- Forks
- 12
- PR merge metrics
- No merged PRs in 30d
Description
Feature idea: Add an option to `.doclets.yml` that enables automatically building documentation for all pull requests. That way it's always easy to check whether documentation changes made by PRs are valid and complete. There could be an extra section in the project's page on doclets.io listing recent PRs.
Cherry on top: Integrate with GitHub status API to display build success/failure and link to output.
Contributor guide
No contributing guide indexed for this repository
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 .doclets.yml configuration and how documentation builds are exposed through doclets.io. Then investigate the GitHub status API and define the scope for pull-request builds, recent-PR display, build results, and output links; the feature is done when those requirements and their validation path are specified.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github, javascript
- Domain
- ci-cd, documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100