chore: upgrade mdbook version#175
Conversation
There was a problem hiding this comment.
Code Review
This pull request cleans up the repository by removing Node.js build scripts, updating mdbook and mdbook-mermaid dependency versions, and escaping HTML angle brackets across several RFC markdown files to prevent rendering issues. It also refactors the Handlebars template (index.hbs) to use a new resource helper and inline SVG icons instead of FontAwesome. Feedback on the changes highlights syntax errors in index.hbs where variables are incorrectly passed as nested string templates to the resource helper. Additionally, a minor grammatical error was found in RFC-0331_Indexers.md, and an unescaped placeholder tag in RFC_template.md needs to be updated to prevent rendering issues.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
| <link rel="stylesheet" href="{{ path_to_root }}css/general.css"> | ||
| <link rel="stylesheet" href="{{ path_to_root }}css/chrome.css"> | ||
| <link rel="stylesheet" href="{{ path_to_root }}css/print.css" media="print"> | ||
| <link rel="shortcut icon" href="{{ resource "{{ favicon }}" }}"> |
There was a problem hiding this comment.
The Handlebars helper resource should take the variable favicon directly as an argument rather than as a nested string template. Using "{{ favicon }}" passes the literal string "{{ favicon }}" to the helper, which will fail to resolve the correct path.
<link rel="shortcut icon" href="{{ resource favicon }}">
| <!-- Custom JS scripts --> | ||
| {{#each additional_js}} | ||
| <script type="text/javascript" src="{{ path_to_root }}{{this}}"></script> | ||
| <script type="text/javascript" src="{{ resource "{{this}}" }}"></script> |
There was a problem hiding this comment.
Similar to the favicon helper call, the this context variable should be passed directly to the resource helper without quotes or nested curly braces. Using "{{this}}" passes the literal string "{{this}}" instead of the actual item value in the loop.
<script type="text/javascript" src="{{ resource this }}"></script>
|  | ||
|
|
||
| The indexer library work via three inter-oparting modules: substate scanning, substate decoding, and the substate | ||
| The indexer library work via three interoperating modules: substate scanning, substate decoding, and the substate |
There was a problem hiding this comment.
There is a minor grammatical issue here: "The indexer library work" should be "The indexer library works" to match the singular subject "library".
| The indexer library work via three interoperating modules: substate scanning, substate decoding, and the substate | |
| The indexer library works via three interoperating modules: substate scanning, substate decoding, and the substate |
| [ The 3-Clause BSD Licence](https://opensource.org/licenses/BSD-3-Clause). | ||
|
|
||
| Copyright <YEAR> <COPYRIGHT HOLDER | The Tari Development Community> | ||
| Copyright <YEAR> <COPYRIGHT HOLDER | The Tari Development Community> |
There was a problem hiding this comment.
In this line, <COPYRIGHT HOLDER | The Tari Development Community> is not escaped or converted to parentheses, which will cause it to be parsed as an invalid HTML tag by mdbook and hidden in the rendered output. Since other placeholders in this file have been updated to use parentheses (e.g., (RFC-Number), (Short Title), (Maintainer name)), we should do the same here for consistency and to avoid rendering issues.
| Copyright <YEAR> <COPYRIGHT HOLDER | The Tari Development Community> | |
| Copyright (YEAR) (COPYRIGHT HOLDER | The Tari Development Community) |
a34f9dc to
3c66688
Compare
3c66688 to
9559e2b
Compare
Description
This merge request upgrades mdbook and mdbook-mermaid.
Motivation and Context
The versions used are quite out of date, making the documentation for them quite out of date, and the available plugins much fewer.
How Has This Been Tested?
Locally, manually. Follow the directions in the
README.mdto give it a run.