Skip to content

Enable Docusaurus future flags to prepare for v4#3403

Open
roynakakawa wants to merge 5 commits into
mainfrom
docs/docusaurus-future-flags
Open

Enable Docusaurus future flags to prepare for v4#3403
roynakakawa wants to merge 5 commits into
mainfrom
docs/docusaurus-future-flags

Conversation

@roynakakawa

@roynakakawa roynakakawa commented Jul 9, 2026

Copy link
Copy Markdown
Collaborator

Content

  • Fixed styling issues after enabling future flags to prepare for Docusaurus v4.
  • Migrated the deprecated onBrokenMarkdownLinks option to markdown.hooks.
  • Fixed admonitions with a custom title.
  • Verified npm run build passes locally (Fedora Linux 44, kernel 7.0.13-200.fc44.x86_64)

Pre-submit checklist

N/A - minor change

Comments

My first PR, so let me know if any additional formatting required.

Issue(s)

Related to draft https://github.com/orgs/input-output-hk/projects/26/views/14?pane=issue&itemId=119928726

@github-actions

github-actions Bot commented Jul 9, 2026

Copy link
Copy Markdown

Test Results

     5 files  ± 0     209 suites  ±0   54m 51s ⏱️ - 2h 24m 39s
 3 301 tests  - 75   3 301 ✅  - 75  0 💤 ±0  0 ❌ ±0 
11 021 runs   - 84  11 021 ✅  - 84  0 💤 ±0  0 ❌ ±0 

Results for commit d643dca. ± Comparison against base commit 86e1c01.

This pull request removes 75 tests.
mithril-stm ‑ circuits::halo2::tests::golden::cases::negative::slow::index_out_of_bounds
mithril-stm ‑ circuits::halo2::tests::golden::cases::negative::slow::index_too_large_for_circuit_range
mithril-stm ‑ circuits::halo2::tests::golden::cases::negative::slow::indices_not_increasing
mithril-stm ‑ circuits::halo2::tests::golden::cases::negative::slow::leaf_merkle_path_mismatch
mithril-stm ‑ circuits::halo2::tests::golden::cases::negative::slow::leaf_swap_keep_merkle_path
mithril-stm ‑ circuits::halo2::tests::golden::cases::negative::slow::leaf_wrong_verification_key
mithril-stm ‑ circuits::halo2::tests::golden::cases::negative::slow::merkle_path_corrupt_sibling
mithril-stm ‑ circuits::halo2::tests::golden::cases::negative::slow::merkle_path_flip_position
mithril-stm ‑ circuits::halo2::tests::golden::cases::negative::slow::merkle_path_length_long
mithril-stm ‑ circuits::halo2::tests::golden::cases::negative::slow::merkle_path_length_short
…

♻️ This comment has been updated with latest results.

@roynakakawa roynakakawa temporarily deployed to testing-2-preview July 9, 2026 13:12 — with GitHub Actions Inactive
@roynakakawa roynakakawa temporarily deployed to testing-preview July 9, 2026 13:12 — with GitHub Actions Inactive

@Alenar Alenar left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Sadly there's two issues:

  1. enabling useCssCascadeLayers just broke the website design except on the home page (see animation)
  2. Admonitions with a custom title are broken (visible at the bottom of the animation, it now show "::note Note")

For 1. it's a limitation with the redesign (#2597) as it straight copied some docusaurus components, meaning that to update them for useCssCascadeLayers we basically have to redo the design.
Here's what the designer answered to that concern:

When upgrading to docusaurus 4 you may indeed need to stash the changed theme components and manually check what/where to change so that you get the same nav and footer component as right now - it may end up being a simple swap in depending on what components are reworked.

Though with it they appear to be shifting away from their .css file and moving to infima so a revision of the docs site will be required regardless of the theme directory components.

We may look into it, but I think that task will be difficult without a designer.

For 2. the fix is simple, the custom title must be surround by brackets, e.g.:

-:::info Update 2024/10/02
+:::info[Update 2024/10/02]

This have to be applied to all admonitions with a custom title (which can be found by tracking :::).

Image

@roynakakawa

Copy link
Copy Markdown
Collaborator Author

thanks @Alenar. I'll take a look and try to fix it.

@roynakakawa roynakakawa force-pushed the docs/docusaurus-future-flags branch from f6f8e42 to 379586f Compare July 13, 2026 14:33
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.

2 participants