Skip to content

Conversation

@rhowardstone
Copy link

Fixes #803

Summary

This PR fixes all broken documentation links (returning 404 errors) in README.md and docs/INDEX.md by correcting paths to point to existing files in their proper subdirectories.

Problem

Issue #803 reported broken links in the documentation. Investigation revealed that many documentation files exist but are located in subdirectories, while the links pointed to the root docs/ directory.

Changes Made

README.md

  • Fixed 7 broken documentation links
  • Updated paths to correct subdirectory locations
  • Removed references to documentation that doesn't exist yet

docs/INDEX.md

  • Fixed 10+ broken documentation links
  • Updated all paths to point to correct subdirectories
  • Cleaned up navigation structure

Path Corrections

  • docs/MCP-TOOLS.mddocs/reference/MCP_TOOLS.md
  • docs/AGENT-SYSTEM.mddocs/reference/AGENTS.md
  • docs/SPARC.mddocs/reference/SPARC.md
  • docs/API_DOCUMENTATION.mddocs/api/API_DOCUMENTATION.md
  • docs/ARCHITECTURE.mddocs/architecture/ARCHITECTURE.md
  • docs/DEPLOYMENT.mddocs/development/DEPLOYMENT.md
  • docs/DEVELOPMENT_WORKFLOW.mddocs/development/DEVELOPMENT_WORKFLOW.md

Testing

  • Verified all updated links point to existing files
  • Checked that removed links reference non-existent documentation
  • No functional changes - documentation links only

Notes

  • Clean fix with no TODO comments or placeholder code
  • Follows existing documentation structure
  • Maintains readability and user experience

🤖 Generated with Claude Code

Fixes ruvnet#803

- Updated paths to point to correct subdirectories (docs/reference/, docs/development/, docs/api/, docs/architecture/)
- Removed links to documentation files that don't exist yet
- Cleaned up formatting for better readability

Files that existed in subdirectories:
- docs/reference/MCP_TOOLS.md (was docs/MCP-TOOLS.md)
- docs/reference/AGENTS.md (was docs/AGENT-SYSTEM.md)
- docs/reference/SPARC.md (was docs/SPARC.md)
- docs/api/API_DOCUMENTATION.md (was docs/API_DOCUMENTATION.md)
- docs/architecture/ARCHITECTURE.md (was docs/ARCHITECTURE.md)
- docs/development/DEPLOYMENT.md (was docs/DEPLOYMENT.md)
- docs/development/DEVELOPMENT_WORKFLOW.md (was docs/DEVELOPMENT_WORKFLOW.md)

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
rhowardstone added a commit to rhowardstone/claude-flow that referenced this pull request Oct 14, 2025
Fixes ruvnet#764

The docs/windows-installation.md file does not exist, causing 404
errors when users click the link. Removed both references to this
missing documentation:
- Line 41: Removed "Windows users" note in Prerequisites section
- Line 309: Removed Windows Installation link from Configuration section

Related to PR ruvnet#804 which fixed similar broken documentation links.

Generated with Claude Code (Sonnet 4.5), checked and approved by rhowardstone
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.

Links to guides in README.md and docs/INDEX.md are broken (404)

1 participant