Skip to content

docs: fix broken README links — wiki pages don't exist yet#13

Merged
arnav2 merged 1 commit into
mainfrom
docs/fix-readme-links
Apr 29, 2026
Merged

docs: fix broken README links — wiki pages don't exist yet#13
arnav2 merged 1 commit into
mainfrom
docs/fix-readme-links

Conversation

@arnav2
Copy link
Copy Markdown
Contributor

@arnav2 arnav2 commented Apr 29, 2026

Summary

The wiki repo is initialized but currently empty (only `Home`), so the README's links to `/wiki/quickstart`, `/wiki/overview`, `/wiki/frameworks/`, `/wiki/book/`, `/wiki/book/flagships-by-tag`, etc. all 404.

This PR repoints every README link at a target that actually resolves:

  • Inline real `## Quickstart` and `## MCP tools used` sections (no longer external).
  • Framework badges + intro paragraph link to the framework's own homepage (langchain.com, langchain-ai.github.io/langgraph, crewai.com, temporal.io, openai-agents-python repo, ai.pydantic.dev, claude.ai/download, cursor.com).
  • Index lists only entries whose targets exist: `#quickstart`, `#flagships-by-vertical`, `recipes/INDEX.md`, framework homepages, `#mcp-tools-used`, `CONTRIBUTING.md`, `INDUSTRIES.md`, and the wiki landing page (which is the only wiki URL that 200s).
  • Browse by tag replaces the broken wiki tag-index link with a one-liner that greps flagship pyproject keywords.

Verification

Ran a link-checker against the README:

```
all 97 link targets resolve.
```

Anchors, in-repo paths, and external HTTP URLs all resolve. The single wiki URL that remains (`/wiki` home) returns 200.

Test plan

  • All 97 README link targets resolve (anchors / in-repo paths / external HTTP).
  • Wiki home returns 200.
  • Render README on GitHub; click through Index, Quickstart, vertical jumps, tag chips. Confirm none 404.

🤖 Generated with Claude Code

The wiki repo is initialized but currently empty (only Home), so links
to /wiki/quickstart, /wiki/overview, /wiki/frameworks/*, /wiki/book/*
all 404. Repoint everything in the README to targets that resolve:

- Add a real ## Quickstart section inline (was a wiki link).
- Add ## MCP tools used inline (was a wiki link).
- Framework badges + intro paragraph link to the framework's own
  homepage (langchain.com, temporal.io, …) instead of empty wiki pages.
- Index now lists only entries whose targets exist: Quickstart anchor,
  Flagships-by-vertical anchor, recipes/INDEX.md, framework
  homepages, MCP-tools anchor, CONTRIBUTING.md, INDUSTRIES.md, and the
  wiki landing page.
- "Browse by tag" replaces the broken wiki tag-index link with a grep
  one-liner over flagship pyproject.toml keywords.
- Link-checker run: 97/97 link targets resolve (anchors, in-repo
  paths, or external HTTP).

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@arnav2 arnav2 requested a review from a team as a code owner April 29, 2026 01:44
@arnav2 arnav2 merged commit 194ec8b into main Apr 29, 2026
2 checks passed
@arnav2 arnav2 deleted the docs/fix-readme-links branch April 29, 2026 02:42
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