-
Notifications
You must be signed in to change notification settings - Fork 572
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] Migrate website to Docusaurus #3646
Conversation
b6c70e5
to
a711612
Compare
--- | ||
|
||
# Appendix | ||
|
||
This section covers some less-common Chisel topics. | ||
|
||
* [Differences between Chisel3 and Chisel2](chisel3-vs-chisel2) |
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.
As far as I can tell, this document doesn't exist, it's a dead link on the current website.
a711612
to
35cb4fd
Compare
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.
LGTM
Questions:
- Do 14k lines of
website/package-lock.json
need to be committed?
website/Makefile
Outdated
$(this_dir)/docs/introduction.md: $(mdoc_out)/introduction.md | ||
mkdir -p $(shell dirname $@) | ||
cp -R $(mdoc_out)/* $(this_dir)/docs/ |
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.
I've had issues with using mkdir -p
in Makefile build rules. I usually write this as an order-only prerequisite on the directory. E.g.:
$(this_dir)/docs/introduction.md: $(mdoc_out)/introduction.md | |
mkdir -p $(shell dirname $@) | |
cp -R $(mdoc_out)/* $(this_dir)/docs/ | |
$(this_dir)/docs/introduction.md: $(mdoc_out)/introduction.md | $(this_dir)/ | |
cp -R $(mdoc_out)/* $(this_dir)/docs/ | |
$(this_dir)/: | |
mkdir -p $@ |
You may be able to use a generic wildcard rule for the directory. I thought old macOS make has issues with this, though:
%/:
mkdir -p $@
Ditto below.
I'm not really sure, my Googling suggested that it is considered best practice, it makes it much easier to reproduce things exactly as they were, especially when "time traveling" back to an older revision. That being said, it also causes merge conflict pain and some people are against committing it so I'll go ahead and remove it. If, in the future, we decide it was a mistake to remove it, we can add it then. |
35cb4fd
to
fcb72ec
Compare
This removes cookbook verilog-vs-chisel which is unfortunate but it has many issues with Docusaurus (via how it processes markdown with MDX). We should resolve these issues and restore the page later.
fcb72ec
to
8b987cc
Compare
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.
LGTM
There are several things that can be improved but I think should be done in follow on PRs:
This removes cookbook verilog-vs-chisel which is unfortunate but it has
many issues with Docusaurus (via how it processes markdown with MDX).
We should resolve these issues and restore the page later.
Note that this page is broken on the website as is:
Contributor Checklist
docs/src
?Type of Improvement
Desired Merge Strategy
Release Notes
Introducing a complete facelift of the Chisel website, now built with Docusaurus 3.0.
Reviewer Checklist (only modified by reviewer)
3.5.x
,3.6.x
, or5.x
depending on impact, API modification or big change:6.0
)?Enable auto-merge (squash)
, clean up the commit message, and label withPlease Merge
.Create a merge commit
.