Verify all Markdown files are linked from SUMMARY.md (or from somewhere else)

Open
#2,358 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
38/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
markdown, rust
Domain
documentation

Research direction

Start by reading the issue's proposed relationship between SUMMARY.md, other linked pages, and Markdown files, then inspect mdBook's existing book-validation or link-checking entry points. Define how unreachable .md files should be detected and reported, and verify that every Markdown file is either reachable from SUMMARY.md or linked from another page.

Written by the indexing model from the issue text.

Description

A-Summary C-enhancement
Question

If not all files are included in the SUMMARY.md and they are also not linked from any other page, there are possible unreachable files. Is it possible to verify that everything .md file is linked from at least some place?

Version

No response

Dominant language
Rust
Stars
22.2k
Forks
1.9k
Avg merge
2d 21h
Merged PRs (30d)
12

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from rust-lang/mdBook

All issues in rust-lang/mdBook

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.