Skip to content

Commit d346c9c

Browse files
committed
fix(docs): resolve relative links by adding explicit .md suffix
Mkdocs treats bare directory URLs (`tests/`, `specs/reference/`) as potential external references and emits INFO-level "unrecognized relative link" messages, leaving the link text as-is. Suffixing with `.md` or `index.md` lets mkdocs resolve the link cleanly and emit the correct URL; the sibling cards in the home page already use this form. Fixes: - `tests/` -> `tests/index.md` in the home page card. - `specs/reference/` -> `specs/reference/index.md` in the home page card and the literate nav entry (now resolves against the stub page added alongside the path rename). - `../tests/prague/.../test_invalid/` -> `.../test_invalid.md` in `writing_tests/post_mortems.md`.
1 parent 5613749 commit d346c9c

3 files changed

Lines changed: 4 additions & 4 deletions

File tree

docs/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,15 +56,15 @@ EELS is a collaborative effort between Ethereum Improvement Proposals (EIP) auth
5656

5757
Browse the rendered Python specifications for the current fork and EIP.
5858

59-
[:octicons-arrow-right-24: Reference ↗](specs/reference/){target=_blank rel=noopener}
59+
[:octicons-arrow-right-24: Reference ↗](specs/reference/index.md){target=_blank rel=noopener}
6060

6161
- :material-format-list-checks: **Test Case Reference**
6262

6363
---
6464

6565
Browse all test cases organized by fork and EIP.
6666

67-
[:octicons-arrow-right-24: Browse tests](tests/)
67+
[:octicons-arrow-right-24: Browse tests](tests/index.md)
6868

6969
</div>
7070

docs/navigation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
* [Installation Troubleshooting](getting_started/installation_troubleshooting.md)
1212
* [Getting Help](getting_started/getting_help.md)
1313
* [Specifications](specs/index.md)
14-
* [Reference ↗](specs/reference/)
14+
* [Reference ↗](specs/reference/index.md)
1515
* [Writing Specs](specs/writing_specs.md)
1616
* [Adding a New EIP](specs/adding_a_new_eip.md)
1717
* [Spec Releases](specs/spec_releases.md)

docs/writing_tests/post_mortems.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ IDs of the tests added that now cover the missed scenario and link to the docume
7878

7979
*Example:*
8080

81-
- [`tests/prague/eip2537_bls_12_381_precompiles/test_bls12_g1msm.py::test_invalid\[fork_Prague-state_test---bls_g1_truncated_input-\]`](../tests/prague/eip2537_bls_12_381_precompiles/test_bls12_g1msm/test_invalid/)
81+
- [`tests/prague/eip2537_bls_12_381_precompiles/test_bls12_g1msm.py::test_invalid\[fork_Prague-state_test---bls_g1_truncated_input-\]`](../tests/prague/eip2537_bls_12_381_precompiles/test_bls12_g1msm/test_invalid.md)
8282

8383
### Framework/Documentation Changes
8484

0 commit comments

Comments
 (0)