rust-lang / rust-lang/mdBook

warn on orphan files

Open
#2,408 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

C-enhancement
Dominant language
Rust
Stars
22.2k
Forks
1.9k
PR merge metrics
PR metrics pending

Description

Problem

Similar to https://github.com/rust-lang/mdBook/issues/702, https://github.com/rust-lang/mdBook/issues/830, but just produce a warning.

BTW, my original motivation is to delete orphan files automatically generated by SUMMARY.md.

Proposed Solution

No response

Notes

No response

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.

Research direction

Start by reading SUMMARY.md handling and the referenced mdBook issues 702 and 830 to understand how orphan files are identified. Trace the relevant book-building entry point, then define the warning behavior and verify that orphan files are reported without being deleted.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.