rustdoc: Consider ways to make UI development cycle faster
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 119k
- Forks
- 16.1k
- PR merge metrics
- PR metrics pending
Description
EDIT: see the below comments instead https://github.com/rust-lang/rust/issues/125991#issuecomment-2148339854 https://github.com/rust-lang/rust/issues/125991#issuecomment-2148417125
The current situation can cause mistakes:
It allows to underline a serious issue when I work on rustdoc front-end: I modify the generated file and not our
main.jsfile, meaning that sometimes, I forget to put all the changes... Thanks for this one!
Originally posted by @GuillaumeGomez in https://github.com/rust-lang/rust/pull/125779#discussion_r1626538444
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 reading the two linked comments, since the issue directs work there; then inspect rustdoc's front end and the generated file versus main.js. Done means a faster UI development cycle that avoids changes being made only in generated output and prevents those changes from being missed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation, frontend
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100