Update docs/README.md - #5441
Open
aishasalim wants to merge 1 commit into
Open
Conversation
The instructions for building the documentation no longer worked: * The build command was given as `docs/mdoc` via SBT, but the project moved to Mill; the command is now `./mill mdoc`. * Building requires Scala CLI and Verilator on the PATH, neither of which was mentioned. Without them the build fails partway through with `Cannot run program "scala-cli"` or `verilator not found on the PATH!`, which is not obviously a missing-dependency problem. * The website was described as a separate repository with edits picked up from the `3.4.x` backport branch. It now lives in `website/` in this repository and is built with Docusaurus, so the sidebar link pointed at a file that no longer exists. * The `mdoc:verilog` example called `ChiselStage.emitVerilog`, which has been replaced by `emitSystemVerilog`. * The links to the per-directory "Contents" pages pointed one directory too deep (`src/cookbooks/cookbooks.md` rather than `src/cookbooks.md`). Adds a section listing where each kind of documentation belongs, and one covering how to render the website locally, both of which were asked for in the issue. Fixes chipsalliance#4402
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The instructions for building the documentation no longer worked:
docs/mdocvia SBT, but the project moved to Mill; the command is now./mill mdoc.Cannot run program "scala-cli"orverilator not found on the PATH!, which is not obviously a missing-dependency problem.3.4.xbackport branch. It now lives inwebsite/in this repository and is built with Docusaurus, so the sidebar link pointed at a file that no longer exists.mdoc:verilogexample calledChiselStage.emitVerilog, which has been replaced byemitSystemVerilog.src/cookbooks/cookbooks.mdrather thansrc/cookbooks.md).Adds a section listing where each kind of documentation belongs, and one covering how to render the website locally, both of which were asked for in the issue.
Fixes #4402
Summary
Release Notes