Skip to content
This repository has been archived by the owner on Nov 1, 2023. It is now read-only.

Adopt the RISC-V documentation format #73

Open
jjscheel opened this issue Jan 21, 2022 · 1 comment
Open

Adopt the RISC-V documentation format #73

jjscheel opened this issue Jan 21, 2022 · 1 comment
Assignees

Comments

@jjscheel
Copy link
Contributor

This is a 3-step update for which I will be submitting a PR:

  1. Import of docs-resources project as a submodule.
  2. Updates to the Makefile to use more options on asciidoctor PDF build, including the RISC-V theme (.yml file) and the fonts directory.
  3. Updates to the main .adoc file to include more variables for the build and the logo for the title page

Once complete, the side-effect for anyone starting to use this repo locally will be that they'll need to learn to use Git Submodules. Plenty of useful information is here. But the key step is to issue a git submodule update --init after a new clone or the first pull after this PR.

At key points in the future, we may want to use the git submodule update to update to a new level because Submodules always "link" at a given commit level. (More discussion here as we work with this.)

If anyone has questions about the process, please free to let me know.

@jjscheel jjscheel self-assigned this Jan 21, 2022
kumarsankaran added a commit that referenced this issue Jan 24, 2022
Adopt the RISC-V documentation format (#73)
@jjscheel
Copy link
Contributor Author

Thanks for merging, @kumarsankaran. I'll leave this open until you feel comfortable that we've addressed any issues with the change. Please close when you are ready.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant