Skip to content

Commit f4b5643

Browse files
johnxieclaude
andauthored
refactor: rename tutorials/*/index.md to README.md for GitHub auto-rendering (#152)
GitHub only auto-renders README.md when browsing directories. Previously, visiting tutorials/langchain-tutorial/ on GitHub showed a file listing — users had to click index.md manually. Now the tutorial content renders automatically. Changes: - rename 191 tutorials/*/index.md → README.md - resolve 10 tutorials that had both files (delete old stub README.md, keep canonical index.md content, then rename) - update 1,550 cross-references in chapter files: (index.md) → (README.md) - update 14 Python scripts to reference README.md instead of index.md - regenerate all discoverability assets, manifest, snapshots, status docs Jekyll compatibility: GitHub Pages includes the jekyll-readme-index plugin by default, which converts README.md to index.html. The has_children: true frontmatter continues to work as before. All CI checks validated locally: - docs_health: 0 broken links, 0 missing indexes - check_index_format_v2: 130 compliant indexes - all diff checks (manifest, snapshot, repo status, discoverability): clean Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 6e26ac2 commit f4b5643

1,747 files changed

Lines changed: 3895 additions & 4581 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

CONTENT_GAPS_ANALYSIS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ High-impact surfaces requiring continuous maintenance:
6060

6161
A tutorial track is considered production-ready when:
6262

63-
- it has `index.md` with valid local links
63+
- it has `README.md` with valid local links
6464
- it has a coherent numbered chapter sequence
6565
- its summary and snapshot language are not stale or placeholder quality
6666
- it passes repository docs health checks

TUTORIAL_STRUCTURE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This file defines the canonical tutorial layout and current structure status.
66

77
```text
88
tutorials/<tutorial-name>/
9-
index.md
9+
README.md
1010
01-*.md
1111
02-*.md
1212
...

discoverability/query-coverage.json

Lines changed: 51 additions & 51 deletions
Large diffs are not rendered by default.

discoverability/query-hub.md

Lines changed: 51 additions & 51 deletions
Large diffs are not rendered by default.

discoverability/search-intent-map.md

Lines changed: 117 additions & 117 deletions
Large diffs are not rendered by default.

discoverability/tutorial-directory.md

Lines changed: 191 additions & 191 deletions
Large diffs are not rendered by default.

discoverability/tutorial-index.json

Lines changed: 382 additions & 382 deletions
Large diffs are not rendered by default.

discoverability/tutorial-itemlist.schema.json

Lines changed: 191 additions & 191 deletions
Large diffs are not rendered by default.

llms-full.txt

Lines changed: 191 additions & 191 deletions
Large diffs are not rendered by default.

scripts/add_index_navigation_backlinks.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
import re
88
from pathlib import Path
99

10-
INDEX_NAME = "index.md"
10+
INDEX_NAME = "README.md"
1111
NAV_HEADING = "## Navigation & Backlinks"
1212
GENERATED_MARKER = "*Generated by [AI Codebase Knowledge Builder]"
1313
NUMBERED_FILE_RE = re.compile(r"^([0-9]{2,})[-_].+\.md$")

0 commit comments

Comments
 (0)