Skip to content

chore: upgrade mdbook version#175

Open
Kelketek wants to merge 1 commit into
tari-project:mainfrom
Kelketek:fox/upgrade-mdbook
Open

chore: upgrade mdbook version#175
Kelketek wants to merge 1 commit into
tari-project:mainfrom
Kelketek:fox/upgrade-mdbook

Conversation

@Kelketek

Copy link
Copy Markdown
Contributor

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.md to give it a run.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread src/theme/index.hbs Outdated
<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 }}" }}">

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

high

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 }}">

Comment thread src/theme/index.hbs Outdated
<!-- Custom JS scripts -->
{{#each additional_js}}
<script type="text/javascript" src="{{ path_to_root }}{{this}}"></script>
<script type="text/javascript" src="{{ resource "{{this}}" }}"></script>

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

high

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>

Comment thread src/RFC-0331_Indexers.md Outdated
![Figure 1: Validator and Indexer](./assets/indexer_vs_vn.jpg)

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

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

There is a minor grammatical issue here: "The indexer library work" should be "The indexer library works" to match the singular subject "library".

Suggested change
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

Comment thread src/RFC_template.md Outdated
[ The 3-Clause BSD Licence](https://opensource.org/licenses/BSD-3-Clause).

Copyright <YEAR> <COPYRIGHT HOLDER | The Tari Development Community>
Copyright &lt;YEAR&gt; <COPYRIGHT HOLDER | The Tari Development Community>

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

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.

Suggested change
Copyright &lt;YEAR&gt; <COPYRIGHT HOLDER | The Tari Development Community>
Copyright (YEAR) (COPYRIGHT HOLDER | The Tari Development Community)

@Kelketek Kelketek force-pushed the fox/upgrade-mdbook branch from a34f9dc to 3c66688 Compare June 13, 2026 01:10
@Kelketek Kelketek force-pushed the fox/upgrade-mdbook branch from 3c66688 to 9559e2b Compare June 13, 2026 01:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant