[specification] PDF update #43
Merged
Conversation
This file contains 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
|
I am OK with the patch. But, CI failed? @sameo |
sameo
added a commit
to sameo/riscv-docs-base-container-image
that referenced
this pull request
Dec 3, 2023
In order to include mermaid diagrams that are both github and asciidoc compatible, we need to include the mermaid-cli package. With that CLI, we can convert github mermaid diagrams on the fly, as shown in riscv-non-isa/riscv-ap-tee-io#43 Signed-off-by: Samuel Ortiz <sameo@rivosinc.com>
Yes, the container image used for building the PDF is missing the mermaid CLI. I opened a PR to fix this: |
jyao1
approved these changes
Dec 5, 2023
|
@sameo , I approved it. Once the CI issue is resolved, you can merge it. |
|
@sameo can you submit the PR again so it can run against the up to date build configuration? |
…agrams In order for mermaid diagrams to render properly on both github and the generated PDF, we need to preprocess the spec source and replace [source,mermaid] occurences with [mermaid] ones. Signed-off-by: Samuel Ortiz <sameo@rivosinc.com>
Signed-off-by: Samuel Ortiz <sameo@rivosinc.com>
|
@sameo let me check why the build fails. |
|
@sameo yes, I was following the build. I will debug it here locally now. |
|
👍 LGTM - hopefully the CI issues have resolved? |
rsahita
approved these changes
Dec 8, 2023
Until the container image is fixed. Signed-off-by: Samuel Ortiz <sameo@rivosinc.com>
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.
Update the PDF with all recently added sections.
Add an
asciidoctor-pdfpreprocessor for it to properly render mermaid diagrams.