lowRISC / lowRISC/opentitan

[doc] Broken Links

Open
#17,658 3 comments 0 reactions 0 assignees View on GitHub
Component:Doc Earlgrey-PROD Triaged
Dominant language
SystemVerilog
Stars
3.6k
Forks
1.1k
Avg merge
2d 22h
Merged PRs (30d)
141

Description

### Description

In the documentation, there are a few broken links to external sites that no longer exist and without straight forward replacements,.

* in `./hw/ip/i2c/README.md` and `./hw/ip/i2c/doc/theory_of_operation.md`.
* in `./doc/security/specs/identities_and_root_keys/README.md`.
* in `./site/landing/layouts/shortcodes/earlgrey-diagram.html`. -> fixed in #21696
* In `./doc/security/implementation_guidelines/hardware/README.md`
*
* which could maybe replaced with
* in `./doc/contributing/dv/methodology/README.md`.

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the links in hw/ip/i2c/README.md, hw/ip/i2c/doc/theory_of_operation.md, doc/security/specs/identities_and_root_keys/README.md, doc/security/implementation_guidelines/hardware/README.md, and doc/contributing/dv/methodology/README.md. Check which URLs remain broken and identify suitable replacements where the issue provides one; the pinmux link is already fixed in #21696. Done means the affected documentation contains working, appropriate links.

Written by the indexing model from the issue text.

Assessment

Domain
documentation, security
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.