[doc] Broken links in OpenTitan repository
@HU90m is already working on this.
Since Aug 7, 2023.
- Dominant language
- SystemVerilog
- Stars
- 3.6k
- Forks
- 1.1k
- Avg merge
- 2d 22h
- Merged PRs (30d)
- 141
Description
### Description
There are many links that refer to the old on-line documentation (https://docs.opentitan.org/...) referenced in various source file of the repository.
These links all lead to HTTP 404 errors since the documentation is now available from https://opentitan.org/book/... and as the documents have been re-organized/split into sub documents, there is no straightforward conversion available.
One solution would have to add a redirector (HTTP 301) to the new URLs, another would be to fix the links in the source code. However, the latter bumped into another issue where the length of the new URLs is larger than the old ones, leading to longer lines in source code, which may break column width rules...
ex:
```
origin: https://docs.opentitan.org/hw/ip/csrng/doc/#working-state-values
update: https://opentitan.org/book/hw/ip/csrng/doc/theory_of_operation.html#working-state-values
```
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.
Assessment
This issue has not been assessed yet.