rust-lang / rust-lang/mdBook

Tried to create a nested Summary, now the whole book is frozen with the error and won't change.

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

Nobody has claimed this yet.

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

Description

Problem

Hi Team,

I am trying to find the right tool to develop a sort of complex textbook.

I tried to make a Summary.md file within a nested folder structure, and now the book is "frozen" in time with that attempt, and no matter how I change it or stop or restart, it remains frozen here:
Image

Steps

Make a normal mdBook with one Summary.md file, appropriately outlined.
Create a folder and make some chapters or sections in that folder. Create a Summary.md file there too.
See what happens...

Possible Solution(s)

No response

Notes

No response

Version

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

Reproduce the issue using a normal mdBook with a root Summary.md, then add chapters and a second Summary.md in a nested folder. Start by tracing how mdBook discovers and processes Summary.md files; done means the book no longer remains frozen after the nested summary is added and subsequent changes or restarts take effect.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.