Large File Table of Contents Overview Generation

Generate table of contents overview for large Markdown files for quick user navigation.

Applicable Conditions

• Markdown file size >= 30KB
• Automatically triggered at onboarding stage 5 (write and update)

Quick Workflow

1. Extract headings: Use Grep to search ^#+\s+.*$
2. Generate overview: Create contents_overview/{filename}_overview.md
3. Update README: Record overview file path

Grep Extract Headings

grep -n '^#' knowledge_base/path/to/file.md

Output example:

10:# Chapter 1 Introduction
150:## 1.1 Background
180:## 1.2 Objectives
400:# Chapter 2 Methodology

Table of Contents Overview Format

See TOC_TEMPLATE.md

README Update Format

- [filename.md](path/to/file.md) (XXX KB) - Brief description [Table of Contents](contents_overview/filename_overview.md)