[doc] Duplicate of wavejson
Open
Nobody has claimed this yet.
Component:Doc
Earlgrey-PROD Triaged
Type:Enhancement
- Dominant language
- SystemVerilog
- Stars
- 3.6k
- Forks
- 1.1k
- Avg merge
- 2d 22h
- Merged PRs (30d)
- 141
Description
### Description
After reviewing https://github.com/lowRISC/opentitan/pull/19144 it seems to me like we should not be hosting these javascript files in the Repo:
https://github.com/lowRISC/opentitan/tree/cb3138483f363aa6cd3cd26ae6343e556cdf58af/util/mdbook/wavejson
We should either vendor them in or fetch them from a CDN.
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 reviewing PR 19144 and the files under util/mdbook/wavejson. Determine whether those JavaScript files should be vendored or fetched from a CDN, then remove the repository-hosted copies accordingly. Done means the wavejson documentation still works without hosting those files directly in the repository.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 28/100