Render API docs in PR previews
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 52
- Forks
- 73
- Avg merge
- 4d 16m
- Merged PRs (30d)
- 8
Description
Description
PR previews like this:
https://github.com/rapidsai/docs/pull/679#issuecomment-3292022542
Don't currently add in all the API docs. That makes it difficult to test changes to https://docs.rapids.ai/api/
The API docs should be rendered in PR previews, or the process to test them should be made easier in some other way.
Benefits of this work
- improves release confidence in changes related to the API docs
- reduces the total maintenance and reviewer effort needed to make changes to the API docs
Acceptance Criteria
- API docs are rendered in PR previews, or some other method exists that makes it easier for contributors and reviewers to preview those docs
Approach
See the following:
- how the site is built on merge: https://github.com/rapidsai/docs/blob/main/.github/workflows/deploy.yaml
- PR that added docs on how to do this locally: #659
- those docs: https://github.com/rapidsai/docs/blob/main/CONTRIBUTING.md#local-macos-development
Notes
N/A
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 with .github/workflows/deploy.yaml to understand how the site is built on merge, then review PR #659 and the CONTRIBUTING.md local-macos-development section. Compare that process with the PR preview linked in the issue. Done means API docs are rendered in PR previews, or contributors and reviewers have an easier documented way to preview them.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- html, yaml
- Domain
- ci-cd, documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100