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

[docs] Minor updates to README and SETUP for Chisel 6 #3745

Merged
merged 1 commit into from
Jan 19, 2024

Conversation

jackkoenig
Copy link
Contributor

Also fix website API doc link generation, links prior to 3.5.4 are not valid (that is when we started publishing the unidoc properly so that it gets picked up by javadoc.io and the like).

Minor fixes/updates, ultimately I want to migrate most of these docs to the website, I have some tweaks there coming soon.

Contributor Checklist

  • Did you add Scaladoc to every public function/method?
  • Did you add at least one test demonstrating the PR?
  • Did you delete any extraneous printlns/debugging code?
  • Did you specify the type of improvement?
  • Did you add appropriate documentation in docs/src?
  • Did you request a desired merge strategy?
  • Did you add text to be included in the Release Notes for this change?

Type of Improvement

  • Documentation or website-related

Desired Merge Strategy

  • Squash: The PR will be squashed and merged (choose this if you have no preference).
  • Rebase: You will rebase the PR onto master and it will be merged with a merge commit.

Release Notes

Reviewer Checklist (only modified by reviewer)

  • Did you add the appropriate labels? (Select the most appropriate one based on the "Type of Improvement")
  • Did you mark the proper milestone (Bug fix: 3.5.x, 3.6.x, or 5.x depending on impact, API modification or big change: 6.0)?
  • Did you review?
  • Did you check whether all relevant Contributor checkboxes have been checked?
  • Did you do one of the following when ready to merge:
    • Squash: You/ the contributor Enable auto-merge (squash), clean up the commit message, and label with Please Merge.
    • Merge: Ensure that contributor has cleaned up their commit history, then merge with Create a merge commit.

Also fix website API doc link generation, links prior to 3.5.4 are not
valid (that is when we started publishing the unidoc properly so that it
gets picked up by javadoc.io and the like).
@jackkoenig jackkoenig added the Documentation Only changing documentation label Jan 19, 2024
@jackkoenig jackkoenig merged commit 3dfe7fe into main Jan 19, 2024
17 checks passed
@jackkoenig jackkoenig deleted the chisel-6-docs-updates branch January 19, 2024 01:35
SpriteOvO pushed a commit to SpriteOvO/chisel that referenced this pull request Jan 20, 2024
…3745)

Also fix website API doc link generation, links prior to 3.5.4 are not
valid (that is when we started publishing the unidoc properly so that it
gets picked up by javadoc.io and the like).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Only changing documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants