rust-lang / rust-lang/rustc-dev-guide
Reorganize files
Open
Nobody has claimed this yet.
A-meta
A-organization
C-cleanup
E-medium
WG-rustc-dev-guide
- Dominant language
- HTML
- Stars
- 1.9k
- Forks
- 613
- Avg merge
- 17h 24m
- Merged PRs (30d)
- 39
Description
- We should reorganize the .md files in the repo. Currently, a lot of them are at the top-level.
- We should rename the
./part-N.mdintro chapters to not haveNso that we can move them around.
This might break some links, so maybe it's not worth it?
@rust-lang/wg-rustc-dev-guide What do you think?
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 inventorying the top-level .md files and references to the ./part-N.md intro chapters. Determine whether a stable reorganization can be agreed on without breaking links; done means the layout is defined, files are moved or renamed accordingly, and affected links remain valid.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100