validation report

Documentation Validation Report

Generated: 2025-12-03 03:35:28

Summary

• Total Files Scanned: 18

File Analysis

AI-Providers.md

Links Found: 19

Code Examples: 48

Missing Sections: Overview, See Also

Last Updated: ✅ Present

Architecture-Overview.md

Links Found: 0

Code Examples: 14

Missing Sections: Overview, See Also

Last Updated: ✅ Present

CLI-Commands.md

Links Found: 35

Code Examples: 69

Missing Sections: Overview, See Also

Last Updated: ✅ Present

Configuration.md

Links Found: 6

Code Examples: 60

Missing Sections: Overview, See Also

Last Updated: ✅ Present

Contributing.md

Links Found: 5

Code Examples: 11

Missing Sections: Overview, See Also

Last Updated: ✅ Present

Development-Roadmap.md

Links Found: 4

Code Examples: 12

Missing Sections: Overview, See Also

Last Updated: ✅ Present

FAQ.md

Links Found: 53

Code Examples: 19

Missing Sections: Overview, See Also

Last Updated: ✅ Present

Glossary.md

Links Found: 0

Code Examples: 0

Missing Sections: Overview, See Also

Last Updated: ✅ Present

Home.md

Links Found: 31

Code Examples: 0

Missing Sections: Overview, See Also

Last Updated: ✅ Present

Installation-Setup.md

Links Found: 7

Code Examples: 19

Missing Sections: Overview, See Also

Last Updated: ✅ Present

Local-Models.md

Links Found: 5

Code Examples: 66

Missing Sections: Overview, See Also

Last Updated: ✅ Present

Phase-1-Completion.md

Links Found: 4

Code Examples: 8

Missing Sections: Overview, See Also

Last Updated: ✅ Present

Project-Status.md

Links Found: 32

Code Examples: 5

Missing Sections: Overview, See Also

Last Updated: ✅ Present

Quick-Start.md

Links Found: 7

Code Examples: 28

Missing Sections: Overview, See Also

Last Updated: ❌ Missing

Spec-Driven-Development.md

Links Found: 4

Code Examples: 35

Missing Sections: Overview, See Also

Last Updated: ✅ Present

Troubleshooting.md

Links Found: 59

Code Examples: 1

Missing Sections: Overview, See Also

Last Updated: ✅ Present

TUI-Interface.md

Links Found: 5

Code Examples: 50

Missing Sections: Overview, See Also

Last Updated: ✅ Present

What-is-RiceCoder.md

Links Found: 7

Code Examples: 3

Missing Sections: Overview, See Also

Last Updated: ❌ Missing

Validation Results

Statistics

• Total Files: 18
• Total Links: 283
• Broken Internal Links: 0
• External Links: 44
• Code Examples: 448

✅ All Internal Links Valid

External Links Found

Note: External links should be manually verified

• File: AI-Providers.md

  • Text: OpenAI Platform
  • URL: https://platform.openai.com

• File: AI-Providers.md

  • Text: OpenAI Pricing
  • URL: https://openai.com/pricing

• File: AI-Providers.md

  • Text: OpenAI Platform
  • URL: https://platform.openai.com/api-keys

• File: AI-Providers.md

  • Text: OpenAI Usage
  • URL: https://platform.openai.com/account/usage/overview

• File: AI-Providers.md

  • Text: Anthropic Console
  • URL: https://console.anthropic.com

• File: AI-Providers.md

  • Text: Anthropic Pricing
  • URL: https://www.anthropic.com/pricing

• File: AI-Providers.md

  • Text: Anthropic Console
  • URL: https://console.anthropic.com/keys

• File: AI-Providers.md

  • Text: Anthropic Documentation
  • URL: https://docs.anthropic.com/claude/reference/getting-started-with-the-api

• File: AI-Providers.md

  • Text: GitHub Copilot
  • URL: https://github.com/features/copilot

• File: AI-Providers.md

  • Text: GitHub Settings - Tokens
  • URL: https://github.com/settings/tokens

• File: AI-Providers.md

  • Text: GitHub Settings
  • URL: https://github.com/settings/tokens

• File: AI-Providers.md

  • Text: GitHub Copilot
  • URL: https://github.com/features/copilot

• File: AI-Providers.md

  • Text: Ollama Website
  • URL: https://ollama.ai

• File: AI-Providers.md

  • Text: OpenAI Usage
  • URL: https://platform.openai.com/account/usage/overview

• File: AI-Providers.md

  • Text: Anthropic Console
  • URL: https://console.anthropic.com

• File: Contributing.md

  • Text: Ask a question
  • URL: https://github.com/moabualruz/ricecoder/issues

• File: Contributing.md

  • Text: General discussion
  • URL: https://github.com/moabualruz/ricecoder/discussions

• File: Contributing.md

  • Text: Community chat
  • URL: https://discord.gg/your-invite

• File: Development-Roadmap.md

  • Text: Report bugs or request features
  • URL: https://github.com/moabualruz/ricecoder/issues

• File: Development-Roadmap.md

  • Text: General discussion
  • URL: https://github.com/moabualruz/ricecoder/discussions

• File: Development-Roadmap.md

  • Text: Community chat
  • URL: https://discord.gg/your-invite

• File: FAQ.md

  • Text: GitHub Discussions
  • URL: https://github.com/moabualruz/ricecoder/discussions

• File: FAQ.md

  • Text: Report bugs
  • URL: https://github.com/moabualruz/ricecoder/issues

• File: FAQ.md

  • Text: Ask questions
  • URL: https://github.com/moabualruz/ricecoder/discussions

• File: Home.md

  • Text: ricecoder
  • URL: https://github.com/moabualruz/ricecoder

• File: Home.md

  • Text: GitHub Issues
  • URL: https://github.com/moabualruz/ricecoder/issues

• File: Home.md

  • Text: GitHub Discussions
  • URL: https://github.com/moabualruz/ricecoder/discussions

• File: Home.md

  • Text: View Specs
  • URL: https://github.com/moabualruz/ricecoder/tree/main/.ai/specs

• File: Home.md

  • Text: View Source Code
  • URL: https://github.com/moabualruz/ricecoder/tree/main/projects/ricecoder

• File: Home.md

  • Text: View Tests
  • URL: https://github.com/moabualruz/ricecoder/tree/main/projects/ricecoder/tests

• File: Installation-Setup.md

  • Text: GitHub Issues
  • URL: https://github.com/moabualruz/ricecoder/issues

• File: Installation-Setup.md

  • Text: GitHub Discussions
  • URL: https://github.com/moabualruz/ricecoder/discussions

• File: Local-Models.md

  • Text: Ollama Official Site
  • URL: https://ollama.ai

• File: Project-Status.md

  • Text: ricecoder
  • URL: https://github.com/moabualruz/ricecoder

• File: Project-Status.md

  • Text: GitHub Issues
  • URL: https://github.com/moabualruz/ricecoder/issues

• File: Project-Status.md

  • Text: GitHub Discussions
  • URL: https://github.com/moabualruz/ricecoder/discussions

• File: Project-Status.md

  • Text: Report bugs or request features
  • URL: https://github.com/moabualruz/ricecoder/issues

• File: Project-Status.md

  • Text: General discussion
  • URL: https://github.com/moabualruz/ricecoder/discussions

• File: Project-Status.md

  • Text: Community chat
  • URL: https://discord.gg/your-invite

• File: Quick-Start.md

  • Text: GitHub Issues
  • URL: https://github.com/moabualruz/ricecoder/issues

• File: Quick-Start.md

  • Text: GitHub Discussions
  • URL: https://github.com/moabualruz/ricecoder/discussions

• File: Troubleshooting.md

  • Text: GitHub Issues
  • URL: https://github.com/moabualruz/ricecoder/issues

• File: Troubleshooting.md

  • Text: GitHub Discussions
  • URL: https://github.com/moabualruz/ricecoder/discussions

• File: Troubleshooting.md

  • Text: Discord
  • URL: https://discord.gg/your-invite-code

Code Examples

Total: 448

• UNSPECIFIED: 448 examples

Issues Found

• ⚠️ MISSING SECTIONS in AI-Providers.md : Overview, See Also
• ⚠️ CODE EXAMPLE in Architecture-Overview.md has no language specified
• ⚠️ CODE EXAMPLE in Architecture-Overview.md has no language specified
• ⚠️ CODE EXAMPLE in Architecture-Overview.md has no language specified
• ⚠️ CODE EXAMPLE in Architecture-Overview.md has no language specified
• ⚠️ CODE EXAMPLE in Architecture-Overview.md has no language specified
• ⚠️ CODE EXAMPLE in Architecture-Overview.md has no language specified
• ⚠️ CODE EXAMPLE in Architecture-Overview.md has no language specified
• ⚠️ CODE EXAMPLE in Architecture-Overview.md has no language specified
• ⚠️ CODE EXAMPLE in Architecture-Overview.md has no language specified
• ⚠️ MISSING SECTIONS in Architecture-Overview.md : Overview, See Also
• ⚠️ MISSING SECTIONS in CLI-Commands.md : Overview, See Also
• ⚠️ CODE EXAMPLE in Configuration.md has no language specified
• ⚠️ MISSING SECTIONS in Configuration.md : Overview, See Also
• ⚠️ MISSING SECTIONS in Contributing.md : Overview, See Also
• ⚠️ CODE EXAMPLE in Development-Roadmap.md has no language specified
• ⚠️ MISSING SECTIONS in Development-Roadmap.md : Overview, See Also
• ⚠️ CODE EXAMPLE in FAQ.md has no language specified
• ⚠️ CODE EXAMPLE in FAQ.md has no language specified
• ⚠️ CODE EXAMPLE in FAQ.md has no language specified
• ⚠️ CODE EXAMPLE in FAQ.md has no language specified
• ⚠️ CODE EXAMPLE in FAQ.md has no language specified
• ⚠️ CODE EXAMPLE in FAQ.md has no language specified
• ⚠️ CODE EXAMPLE in FAQ.md has no language specified
• ⚠️ MISSING SECTIONS in FAQ.md : Overview, See Also
• ⚠️ MISSING SECTIONS in Glossary.md : Overview, See Also
• ⚠️ MISSING SECTIONS in Home.md : Overview, See Also
• ⚠️ MISSING SECTIONS in Installation-Setup.md : Overview, See Also
• ⚠️ CODE EXAMPLE in Local-Models.md has no language specified
• ⚠️ CODE EXAMPLE in Local-Models.md has no language specified
• ⚠️ CODE EXAMPLE in Local-Models.md has no language specified
• ⚠️ MISSING SECTIONS in Local-Models.md : Overview, See Also
• ⚠️ CODE EXAMPLE in Phase-1-Completion.md has no language specified
• ⚠️ CODE EXAMPLE in Phase-1-Completion.md has no language specified
• ⚠️ CODE EXAMPLE in Phase-1-Completion.md has no language specified
• ⚠️ MISSING SECTIONS in Phase-1-Completion.md : Overview, See Also
• ⚠️ CODE EXAMPLE in Project-Status.md has no language specified
• ⚠️ CODE EXAMPLE in Project-Status.md has no language specified
• ⚠️ CODE EXAMPLE in Project-Status.md has no language specified
• ⚠️ CODE EXAMPLE in Project-Status.md has no language specified
• ⚠️ MISSING SECTIONS in Project-Status.md : Overview, See Also
• ⚠️ CODE EXAMPLE in Quick-Start.md has no language specified
• ⚠️ CODE EXAMPLE in Quick-Start.md has no language specified
• ⚠️ CODE EXAMPLE in Quick-Start.md has no language specified
• ⚠️ CODE EXAMPLE in Quick-Start.md has no language specified
• ⚠️ MISSING SECTIONS in Quick-Start.md : Overview, See Also
• ⚠️ NO LAST UPDATED DATE in Quick-Start.md
• ⚠️ CODE EXAMPLE in Spec-Driven-Development.md has no language specified
• ⚠️ CODE EXAMPLE in Spec-Driven-Development.md has no language specified
• ⚠️ CODE EXAMPLE in Spec-Driven-Development.md has no language specified
• ⚠️ CODE EXAMPLE in Spec-Driven-Development.md has no language specified
• ⚠️ CODE EXAMPLE in Spec-Driven-Development.md has no language specified
• ⚠️ CODE EXAMPLE in Spec-Driven-Development.md has no language specified
• ⚠️ CODE EXAMPLE in Spec-Driven-Development.md has no language specified
• ⚠️ CODE EXAMPLE in Spec-Driven-Development.md has no language specified
• ⚠️ CODE EXAMPLE in Spec-Driven-Development.md has no language specified
• ⚠️ CODE EXAMPLE in Spec-Driven-Development.md has no language specified
• ⚠️ CODE EXAMPLE in Spec-Driven-Development.md has no language specified
• ⚠️ CODE EXAMPLE in Spec-Driven-Development.md has no language specified
• ⚠️ CODE EXAMPLE in Spec-Driven-Development.md has no language specified
• ⚠️ CODE EXAMPLE in Spec-Driven-Development.md has no language specified
• ⚠️ CODE EXAMPLE in Spec-Driven-Development.md has no language specified
• ⚠️ MISSING SECTIONS in Spec-Driven-Development.md : Overview, See Also
• ⚠️ MISSING SECTIONS in Troubleshooting.md : Overview, See Also
• ⚠️ CODE EXAMPLE in TUI-Interface.md has no language specified
• ⚠️ CODE EXAMPLE in TUI-Interface.md has no language specified
• ⚠️ CODE EXAMPLE in TUI-Interface.md has no language specified
• ⚠️ CODE EXAMPLE in TUI-Interface.md has no language specified
• ⚠️ CODE EXAMPLE in TUI-Interface.md has no language specified
• ⚠️ MISSING SECTIONS in TUI-Interface.md : Overview, See Also
• ⚠️ CODE EXAMPLE in What-is-RiceCoder.md has no language specified
• ⚠️ CODE EXAMPLE in What-is-RiceCoder.md has no language specified
• ⚠️ CODE EXAMPLE in What-is-RiceCoder.md has no language specified
• ⚠️ MISSING SECTIONS in What-is-RiceCoder.md : Overview, See Also
• ⚠️ NO LAST UPDATED DATE in What-is-RiceCoder.md

Status

⚠️ PASS WITH WARNINGS: Some issues found but no broken links