refactor: rename tutorials/*/index.md to README.md for GitHub auto-rendering#152
Merged
refactor: rename tutorials/*/index.md to README.md for GitHub auto-rendering#152
Conversation
…ndering 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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
tutorials/*/index.md→README.mdso GitHub auto-renders tutorial content when browsing directories (previously required clickingindex.mdmanually)(index.md)→(README.md)README.mdinstead ofindex.mdJekyll compatibility: GitHub Pages includes the
jekyll-readme-indexplugin by default, which convertsREADME.mdtoindex.html. Thehas_children: truefrontmatter continues to work.Validated locally
docs_health.py: 0 broken links, 0 missing indexescheck_index_format_v2.py: 130 compliant v2 indexesTest plan
tutorials/langchain-tutorial/on GitHub — README.md auto-rendersindex.mdfiles remain in tutorial directories🤖 Generated with Claude Code