Commit f4b5643
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
- discoverability
- scripts
- tutorials
- activepieces-tutorial
- adk-python-tutorial
- ag2-tutorial
- agentgpt-tutorial
- agenticseek-tutorial
- agents-md-tutorial
- agno-tutorial
- aider-tutorial
- anthropic-code-tutorial
- anthropic-skills-tutorial
- anything-llm-tutorial
- athens-research-knowledge-graph
- autoagent-tutorial
- autogen-tutorial
- awesome-claude-code-tutorial
- awesome-claude-skills-tutorial
- awesome-mcp-servers-tutorial
- awslabs-mcp-tutorial
- babyagi-tutorial
- beads-tutorial
- bentoml-tutorial
- bolt-diy-tutorial
- botpress-tutorial
- browser-use-tutorial
- chatbox-tutorial
- cherry-studio-tutorial
- chroma-tutorial
- chrome-devtools-mcp-tutorial
- cipher-tutorial
- claude-code-router-tutorial
- claude-code-tutorial
- claude-flow-tutorial
- claude-mem-tutorial
- claude-plugins-official-tutorial
- claude-quickstarts-tutorial
- claude-squad-tutorial
- claude-task-master-tutorial
- clickhouse-tutorial
- cline-tutorial
- codemachine-cli-tutorial
- codex-analysis-platform
- codex-cli-tutorial
- comfyui-tutorial
- composio-tutorial
- compound-engineering-plugin-tutorial
- context7-tutorial
- continue-tutorial
- copilot-cli-tutorial
- copilotkit-tutorial
- create-python-server-tutorial
- create-typescript-server-tutorial
- crewai-tutorial
- crush-tutorial
- daytona-tutorial
- deer-flow-tutorial
- devika-tutorial
- dify-platform-deep-dive
- dspy-tutorial
- dyad-tutorial
- elizaos-tutorial
- everything-claude-code-tutorial
- fabric-tutorial
- fastmcp-tutorial
- figma-context-mcp-tutorial
- firecrawl-mcp-server-tutorial
- firecrawl-tutorial
- fireproof-tutorial
- flowise-llm-orchestration
- gemini-cli-tutorial
- genai-toolbox-tutorial
- github-mcp-server-tutorial
- goose-tutorial
- gpt-oss-tutorial
- gptme-tutorial
- hapi-tutorial
- haystack-tutorial
- huggingface-tutorial
- humanlayer-tutorial
- instructor-tutorial
- khoj-tutorial
- kilocode-tutorial
- kimi-cli-tutorial
- kiro-tutorial
- kubernetes-operator-patterns
- lancedb-tutorial
- langchain-architecture-guide
- langchain-tutorial
- langflow-tutorial
- langfuse-tutorial
- langgraph-tutorial
- letta-tutorial
- litellm-tutorial
- liveblocks-tutorial
- llama-cpp-tutorial
- llama-factory-tutorial
- llamaindex-tutorial
- lobechat-ai-platform
- localai-tutorial
- logseq-knowledge-management
- mastra-tutorial
- mcp-chrome-tutorial
- mcp-csharp-sdk-tutorial
- mcp-docs-repo-tutorial
- mcp-ext-apps-tutorial
- mcp-go-sdk-tutorial
- mcp-inspector-tutorial
- mcp-java-sdk-tutorial
- mcp-kotlin-sdk-tutorial
- mcp-php-sdk-tutorial
- mcp-python-sdk-tutorial
- mcp-quickstart-resources-tutorial
- mcp-registry-tutorial
- mcp-ruby-sdk-tutorial
- mcp-rust-sdk-tutorial
- mcp-servers-tutorial
- mcp-specification-tutorial
- mcp-swift-sdk-tutorial
- mcp-typescript-sdk-tutorial
- mcp-use-tutorial
- mcpb-tutorial
- meilisearch-tutorial
- mem0-tutorial
- mini-swe-agent-tutorial
- mistral-vibe-tutorial
- n8n-ai-tutorial
- n8n-mcp-tutorial
- nanocoder-tutorial
- nocodb-database-platform
- obsidian-outliner-plugin
- ollama-tutorial
- onlook-tutorial
- opcode-tutorial
- open-swe-tutorial
- open-webui-tutorial
- openai-python-sdk-tutorial
- openai-realtime-agents-tutorial
- openai-whisper-tutorial
- openbb-tutorial
- openclaw-tutorial
- opencode-ai-legacy-tutorial
- opencode-tutorial
- openhands-tutorial
- openskills-tutorial
- openspec-tutorial
- opensrc-tutorial
- outlines-tutorial
- perplexica-tutorial
- phidata-tutorial
- photoprism-tutorial
- plandex-tutorial
- planning-with-files-tutorial
- playwright-mcp-tutorial
- pocketflow-tutorial
- postgresql-query-planner
- posthog-tutorial
- pydantic-ai-tutorial
- quivr-tutorial
- qwen-agent-tutorial
- ragflow-tutorial
- react-fiber-internals
- refly-tutorial
- roo-code-tutorial
- semantic-kernel-tutorial
- serena-tutorial
- shotgun-tutorial
- sillytavern-tutorial
- siyuan-tutorial
- smolagents-tutorial
- stagewise-tutorial
- strands-agents-tutorial
- supabase-tutorial
- superagi-tutorial
- superset-terminal-tutorial
- swarm-tutorial
- swe-agent-tutorial
- sweep-tutorial
- tabby-tutorial
- taskade-awesome-vibe-coding-tutorial
- taskade-docs-tutorial
- taskade-mcp-tutorial
- taskade-tutorial
- teable-database-platform
- tiktoken-tutorial
- turborepo-tutorial
- use-mcp-tutorial
- vercel-ai-tutorial
- vibe-kanban-tutorial
- vibesdk-tutorial
- vllm-tutorial
- whisper-cpp-tutorial
- wshobson-agents-tutorial
Some content is hidden
Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
60 | 60 | | |
61 | 61 | | |
62 | 62 | | |
63 | | - | |
| 63 | + | |
64 | 64 | | |
65 | 65 | | |
66 | 66 | | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
6 | 6 | | |
7 | 7 | | |
8 | 8 | | |
9 | | - | |
| 9 | + | |
10 | 10 | | |
11 | 11 | | |
12 | 12 | | |
| |||
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
7 | 7 | | |
8 | 8 | | |
9 | 9 | | |
10 | | - | |
| 10 | + | |
11 | 11 | | |
12 | 12 | | |
13 | 13 | | |
| |||
0 commit comments