DataView explanation doc is not linked from explanation page or sidebar
See original GitHub issueType of issue: documentation
Impact: no functional change
Development Phase: request Other information
If the current behavior is a bug, please provide the steps to reproduce the problem:
DataView (and perhaps other) explanations are not referenced from the Explanation page table of contents, and thus do not not show up on the website
https://github.com/chipsalliance/chisel3/blob/master/docs/src/explanations/dataview.md
What is the current behavior? DataView explanation docs are available only by browsing to the actual file on GitHub
What is the expected behavior?
Dataview explanation doc would be available from the explanations page: https://github.com/chipsalliance/chisel3/blob/master/docs/src/explanations/explanations.md and from the sidebar: https://github.com/freechipsproject/www.chisel-lang.org/blob/ef93edd993b9e64a26d076626597b0ca10e3f696/docs/src/main/resources/microsite/data/menu.yml#L30
There may be other missing explanation docs.
Please tell us about your environment:
What is the use case for changing the behavior?
Being able to find out more about DataView once it goes live in 3.5
Issue Analytics
- State:
- Created 2 years ago
- Comments:6 (4 by maintainers)
Top GitHub Comments
Hi @mwachs5 Please can I work on this issue?
Hi @mwachs5 I just checked now and it seems #2185 is already taken… Please do you have any other suggestions? Would love to get started soon. Thank you! 😃