Can `./x doc xxx` be exercised in PR CI or earlier?
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 119k
- Forks
- 16.1k
- PR merge metrics
- PR metrics pending
Description
Tool docs like ./x doc src/tools/compiletest seemingly are run very late into the full CI pipeline, but that seems relatively easy and cheap to either run in PR CI or perhaps earlier in full CI? That might help to catch trivial broken intradoc links which can fail full CI like 2 hours in...
Not sure about compiler/std docs, but some tool docs might be okay to move earlier into the pipelines?
T-infra zulip link: https://rust-lang.zulipchat.com/#narrow/channel/242791-t-infra/topic/Can.20some.20doc.20checks.20happen.20in.20PR.20CI.20or.20happen.20earlier.3F
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
Begin with the ./x doc src/tools/compiletest command and trace where that check is scheduled in PR and full CI. Compare the eligible tool-doc checks with compiler and std docs; done means establishing which checks can run earlier and where they should be placed to catch broken intradoc links sooner.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- ci-cd, documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100