Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DataView explanation doc is not linked from explanation page or sidebar #2165

Closed
mwachs5 opened this issue Oct 11, 2021 · 6 comments
Closed
Labels
good first issue An issue whose fix is simple. Perfect for a new developer wanting to get involved!

Comments

@mwachs5
Copy link
Contributor

mwachs5 commented Oct 11, 2021

Type 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

@mwachs5 mwachs5 added the good first issue An issue whose fix is simple. Perfect for a new developer wanting to get involved! label Oct 11, 2021
@Burnleydev1
Copy link
Contributor

Hi @mwachs5 Please can I work on this issue?

@OyinOlamide
Copy link

Hello @mwachs5 I'd like to resolve this issue. Can I please be assigned to it? Thank you.

@mwachs5
Copy link
Contributor Author

mwachs5 commented Oct 15, 2021

Hi @OyinOlamide , please do!

@mwachs5
Copy link
Contributor Author

mwachs5 commented Oct 15, 2021

I think @Burnleydev1 already has a PR open for the part about the sidebar, but I don't think there is one for the explanation page?

@mwachs5
Copy link
Contributor Author

mwachs5 commented Oct 15, 2021

Actually looks like this was already resolved in #2167 and there is a PR open on the sidebar at https://github.com/freechipsproject/www.chisel-lang.org/pull/201/files, so another good issue for you to look at @OyinOlamide would be #2185 ?

@OyinOlamide
Copy link

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! :)

jackkoenig added a commit that referenced this issue Feb 28, 2023
* Fix Mill support for non-M1 Macs

* Update build.sc

Co-authored-by: edwardcwang <[email protected]>

Co-authored-by: edwardcwang <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue An issue whose fix is simple. Perfect for a new developer wanting to get involved!
Projects
None yet
Development

No branches or pull requests

4 participants