Skip to content

docs: one root README for all modules - #11

Merged
kushalBanda merged 1 commit into
mainfrom
docs/single-readme
Oct 9, 2026
Merged

kushalBanda merged 1 commit into
mainfrom
docs/single-readme

Conversation

@kushalBanda

Copy link
Copy Markdown
Owner

Summary

  • Merges all 31 sub READMEs into the root README.md. Each module is now a section under its tier, and the README has a full table of contents and a "Projects by difficulty" table.
  • Includes all seven MCP crash course lessons, the full prompting guides index with PDF links, and the GitHub sync client, server, and Kafka notes.
  • Rewrites relative links to repo-root paths. All 52 anchors and every local link resolve.
  • Deletes the sub READMEs and removes readme = "README.md" from 5 module pyproject.toml files (uv lockfiles still check out).
  • Updates CONTRIBUTING.md and the PR template, and replaces the module README template with .github/MODULE_SECTION_TEMPLATE.md.
  • Drops the "Article: Coming soon" placeholders.

🤖 Generated with Claude Code

Fold the 31 per-module READMEs (including all seven MCP lessons and
the prompting guide index) into sections of the root README, with a
tier table, full table of contents, and repo-root paths. Delete the
sub READMEs, drop the now-dangling `readme` field from module
pyproject files, and update the contributor docs and template to the
single-README layout.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@kushalBanda
kushalBanda merged commit 079729b into main Oct 9, 2026
2 checks passed
@kushalBanda
kushalBanda deleted the docs/single-readme branch October 9, 2026 13:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant