-
Notifications
You must be signed in to change notification settings - Fork 603
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
Reorganize website docs #1806
Reorganize website docs #1806
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Overall this looks good, I do have a couple of questions / comments
I'd also like to note my comment here: #1805 (comment) There's at least 1 page still existing on the Wiki that doesn't exist on the website. |
"I'd also like to note my comment here: #1805 (comment) There's at least 1 page still existing on the Wiki that doesn't exist on the website." -- added this content under the experimental features section |
@jackkoenig , @seldridge I think I am ready for a review on this. There is one unresolved change moving from chisel3.Driver to ChiselStage. This is also seemingly failing CI due to inability to grab dependencies. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Found the remaining question I had about getting the annotations example to work (@azidar , @jackkoenig ?)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is fantastic, thank you so much @mwachs5! I have a few suggestions but this is a huge improvement!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Amazing.
Thanks for tackling this @mwachs5!
c636ad9
to
e713d5f
Compare
* guard code examples with mdoc and fix errors encountered along the way * move some website content here vs splitting the content across two repos * Bring in the interval-types and loading memories content so that it will be visible from the website * remove all references to the wiki (deprecated) * Remove reference to Wiki from the README
29d2090
to
6e833dc
Compare
I've realized why the links don't work if we put |
Co-authored-by: Jack Koenig <koenig@sifive.com>
Co-authored-by: Jack Koenig <koenig@sifive.com>
Updates to chisel3 documentation for website: * guard code examples with mdoc and fix errors encountered along the way * move some website content here vs splitting the content across two repos * Bring in the interval-types and loading memories content so that it will be visible from the website * remove all references to the wiki (deprecated) * Remove reference to Wiki from the README * fix tabbing and compile of chisel3-vs-chisel2 section * Appendix: faqs now guarded and compile * FAQs: move to resources section (cherry picked from commit f1ad5b5)
Updates to chisel3 documentation for website: * guard code examples with mdoc and fix errors encountered along the way * move some website content here vs splitting the content across two repos * Bring in the interval-types and loading memories content so that it will be visible from the website * remove all references to the wiki (deprecated) * Remove reference to Wiki from the README * fix tabbing and compile of chisel3-vs-chisel2 section * Appendix: faqs now guarded and compile * FAQs: move to resources section (cherry picked from commit f1ad5b5) Co-authored-by: Megan Wachs <megan@sifive.com>
After realizing that the oh-so-handy
Cookbook
wasn't discoverable on the website, I went on a bender of finally getting rid of the "Wiki (Deprecated)" section, which turned into a bunch of docs cleanup.This PR:
Developers
andResources
section, then moves everything out of thewiki (Deprecated)
into one of the existing sections, the vast majority into theexplanations
category. I thought most of the content was of that sort. I did not try to split up any individual articles.mdoc
checks as much as possible around all the code snippets and corrected a few things found in this way.md
"landing" pages for each section from the website repo directly to here for a more consistent editing experience, and put links on each of them to the contentI somewhat cleaned up the FAQ section, but as it is I don't think the "how to verilog" instructions are solid enough so my website PR does not include the FAQCleaned up the FAQ section and added it to the ResourcesContributor Checklist
docs/src
?Type of Improvement
API Impact
Backend Code Generation Impact
No impact on backend code
Desired Merge Strategy
Release Notes
Documentation reorganized, wiki content redistributed.
Reviewer Checklist (only modified by reviewer)
Please Merge
?