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.

Sign up for GitHub

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

Jump to bottom

[WIP] Documentation Plan #2960

Open
sequencer opened this issue Apr 8, 2022 · 2 comments
Open

[WIP] Documentation Plan #2960

sequencer opened this issue Apr 8, 2022 · 2 comments
Labels
documentation

Comments

@sequencer
Copy link
Member

Type of issue: feature request

Impact: no functional change

Development Phase: request

Other information
This was referenced Apr 8, 2022
Closed
Closed
Closed
Closed
This was referenced Apr 12, 2022
Closed
Open
michael-etzkorn added a commit that referenced this issue Apr 14, 2022
@michael-etzkorn
[CRC.scala] Note CRC's object explicit+1 notation
481dadb 
#2963 just so users can follow the CRC object's API a bit better. 


Perhaps #2960 should include a scala doc
This was referenced Apr 14, 2022
Merged
Closed
@michael-etzkorn
Copy link
Contributor

michael-etzkorn commented May 3, 2022 •
edited
Loading

A small list of things to provide quality documentation for:

  • FPGA and ASIC flow resources
  • Configurations and Keys/Fields/Parameters
  • RC's microarchitecture. Doc similar to BOOM's.
  • Running unit tests
  • Running benchmarking and using Hardware Performance Monitors
  • RoCC
  • Bus Topology and Bus APIs. e.g.:
    • Diplomatic Widgets
    • Location API
  • Device tree
  • Version releases - PRs should correlate to version updates and there should be patch notes with each release

@michael-etzkorn michael-etzkorn mentioned this issue May 12, 2022
Closed
This was referenced Jun 4, 2022
Closed
Closed
Closed
@michael-etzkorn michael-etzkorn mentioned this issue Sep 20, 2022
Closed
This was referenced Oct 10, 2022
Merged
Closed
@michael-etzkorn michael-etzkorn mentioned this issue Jan 12, 2023
Closed
@michael-etzkorn michael-etzkorn mentioned this issue Jan 19, 2023
Open
@michael-etzkorn michael-etzkorn mentioned this issue Mar 20, 2023
Open
@rstarc
Copy link

rstarc commented Aug 19, 2023

What is the status of this issue? I would like to contribute
I see that there are multiple seemingly related branches named *_doc containing unmerged commits. Is anyone actively else actively working on this?

@michael-etzkorn michael-etzkorn mentioned this issue Jul 24, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@sequencer @rstarc @michael-etzkorn