Skip to content

Fix warnings generated by mdbook build - #20217

Merged
anoadragon453 merged 3 commits into
developfrom
anoa/mdbook_fix_warnings
Sep 11, 2026
Merged

anoadragon453 merged 3 commits into
developfrom
anoa/mdbook_fix_warnings

Conversation

@anoadragon453

@anoadragon453 anoadragon453 commented Sep 11, 2026 •

Copy link
Copy Markdown
Member

mdbook build was emitting the following warnings:

$ mdbook build
 INFO Running the html backend
 WARN unclosed HTML tag `<version>` found in `usage/configuration/config_documentation.md` while exiting Paragraph
HTML tags must be closed before exiting a markdown element.
 WARN unclosed HTML tag `<details>` found in `openid.md` while exiting Item
HTML tags must be closed before exiting a markdown element.
 WARN unexpected HTML end tag `</details>` found in `openid.md`
Check that the HTML tags are properly balanced.
 WARN unexpected HTML end tag `</table>` found in `development/synapse_architecture/cancellation.md`
Check that the HTML tags are properly balanced.
 WARN unclosed HTML tag `<tr>` found in `development/synapse_architecture/cancellation.md`
 WARN unclosed HTML tag `<table>` found in `development/synapse_architecture/cancellation.md`
 INFO HTML book written to `/home/runner/work/synapse/synapse/book`

which made reading the output cumbersome. This PR fixes them up.

I briefly thought about promoting these warnings to errors, but mdbook does not offer such an option yet.

Pull Request Checklist

  • Pull request is based on the develop branch
  • Pull request includes a changelog file. The entry should:
    • Be a short description of your change which makes sense to users. "Fixed a bug that prevented receiving messages from other servers." instead of "Moved X method from EventStore to EventWorkerStore.".
    • Use markdown where necessary, mostly for code blocks.
    • End with either a period (.) or an exclamation mark (!).
    • Start with a capital letter.
    • Feel free to credit yourself, by adding a sentence "Contributed by @github_username." or "Contributed by [Your Name]." to the end of the entry.
  • Code style is correct (run the linters)

@anoadragon453
anoadragon453 marked this pull request as ready for review September 11, 2026 09:25
@anoadragon453
anoadragon453 requested a review from a team as a code owner September 11, 2026 09:25
@anoadragon453
anoadragon453 requested review from MadLittleMods and removed request for a team September 11, 2026 09:25
@anoadragon453
anoadragon453 merged commit 46f3eb0 into develop Sep 11, 2026
39 checks passed
@anoadragon453
anoadragon453 deleted the anoa/mdbook_fix_warnings branch September 11, 2026 13:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants