`include` does not work in SUMMARY.md
Open
Nobody has claimed this yet.
A-Summary
C-enhancement
- Dominant language
- Rust
- Stars
- 22.2k
- Forks
- 1.9k
- PR merge metrics
- PR metrics pending
Description
Problem
This is a reopening of issue #1116
I think this feature would provide the most natural way to support auto-generated documentation. One could autogen a whole tree of md's and then a snippet TOC that gets included in SUMMARY.md.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the earlier issue #1116 and the existing SUMMARY.md behavior in mdBook. Clarify the expected include syntax, scope, and generated-documentation use case before identifying implementation and test locations. Done means the agreed inclusion behavior works for the documented example and has regression coverage.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100