Provide a migration page from the old single page to new split reference pages format
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- rust
- Domain
- documentation
Research direction
Start by reviewing the old reference URL and the split chapter pages, using the tuple-types example to understand the required anchor mapping. Inventory every anchor from the old single-page reference and determine how the migration page should direct each one to its new location. Done means old links lead to the corresponding moved section instead of a dead or misleading page.
Written by the indexing model from the issue text.
Description
Since Rust Reference underwent the split by chapters, all the links in the wild, like in answers on StackOverflow, are effectively dead, because they don't lead to the relevant parts of Reference anymore.
I realise the problems of handling url fragments, but couldn't a migration page be generated? Like http://doc.rust-lang.org/reference.html#tuple-types should go to a place in the page which says "This section has been moved to https://doc.rust-lang.org/reference/types.html#tuple-types", and so on for every anchor in the old reference page.
This would be much more helpful, as searching whatever chapters possibly contain the relevant data manually isn't quite easy.
- Dominant language
- Rust
- Stars
- 1.6k
- Forks
- 607
- Avg merge
- 1d 1h
- Merged PRs (30d)
- 12
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.
More from rust-lang/reference
-
A-const-eval A-undefined-behavior
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
A-resolve
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
-
A-coercions
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
All issues in rust-lang/reference
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
kwakseongjae/auto-hwp#319 ·
-
area:cli bug filter-quality good first issue priority:medium
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
-
Difficulty 1/5 Under an hour Newbie friendliness 72/100
bevyengine/bevy#25861 ·
-
comp-datalake
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
ClickHouse/ClickHouse#121222 ·
-
enhancement remote
Difficulty 2/5 1-3 hours Newbie friendliness 68/100