Skip to content

Add Reference section to navigation for llms.txt and llms-full.txt#39

Merged
wtfsayo merged 3 commits intomainfrom
add-reference-section-navigation
Jul 25, 2025
Merged

Add Reference section to navigation for llms.txt and llms-full.txt#39
wtfsayo merged 3 commits intomainfrom
add-reference-section-navigation

Conversation

@wtfsayo
Copy link
Copy Markdown
Member

@wtfsayo wtfsayo commented Jul 25, 2025

Summary

Adds a new Reference section to the bottom of the Docs tab navigation to include links for llms.txt and llms-full.txt files.

Changes

  • Added new "Reference" section at the bottom of the Docs tab navigation in docs.json
  • Includes navigation links for llms and llms-full files
  • Uses file-text icon for visual consistency
  • Follows standard documentation pattern with reference materials appearing at the end

Navigation Structure

The sidebar will now show:

  • Getting Started
  • Core Concepts
  • Deep Dive
  • Guides
  • Reference 📄
    • llms
    • llms-full

This provides easy access to LLM reference files while keeping them separate from tutorial content.

- Added new Reference section at bottom of Docs tab navigation
- Includes navigation links for llms and llms-full files
- Uses file-text icon for visual consistency
- Follows standard documentation pattern with reference materials at end
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Jul 25, 2025

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch add-reference-section-navigation

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@claude
Copy link
Copy Markdown
Contributor

claude bot commented Jul 25, 2025

Claude finished @wtfsayo's task —— View job


Documentation PR Review

Reviewed this PR against Mintlify documentation standards.

Review Tasks:

  • Analyze modified docs.json file
  • Verify referenced llms.txt and llms-full.txt files exist
  • Check navigation structure and organization
  • Review against documentation standards
  • Provide specific feedback and recommendations

Findings:

❌ Critical Issues

1. Broken Navigation Links (docs.json:71)

  • Navigation references "llms" and "llms-full" pages that don't exist
  • Expected files llms.mdx and llms-full.mdx are missing from the repository
  • This will create 404 errors when users click these navigation links

✅ Positive Aspects

1. Navigation Structure & Organization

  • Placement of Reference section at the bottom follows logical hierarchy
  • Consistent with standard documentation patterns (Getting Started → Core → Deep Dive → Guides → Reference)
  • Icon choice (file-text) is appropriate for reference materials

2. Code Quality

  • JSON syntax is valid
  • Follows existing formatting patterns
  • Indentation and structure are consistent

📋 Recommendations

Required Actions:

  1. Create the missing MDX files before merging:
    • Create llms.mdx with proper frontmatter (title, description)
    • Create llms-full.mdx with proper frontmatter
    • Ensure both files follow Mintlify MDX standards

Content Standards for New Files:

  • Include YAML frontmatter with title and description
  • Do NOT add H1 headers (# Title) in content - Mintlify creates these from frontmatter
  • Use second-person voice ("you")
  • Include code blocks with proper language tags if applicable
  • Use Mintlify components (<Note>, <Tip>, etc.) appropriately

Alternative Solutions:

  • Remove the Reference section entirely until files are ready
  • Create placeholder pages with "Coming Soon" content
  • Link to external llms.txt files if they exist elsewhere

Verdict

❌ Cannot approve - Critical broken links must be resolved before merge.


@claude
Copy link
Copy Markdown
Contributor

claude bot commented Jul 25, 2025

Claude finished @wtfsayo's task —— View job


Link Checking and Fixing Task ✅ Complete

I have successfully completed a comprehensive link check and fix across all documentation in the repository.

Final Results Summary:

  • 133+ files scanned (130+ MDX, 3 MD files)
  • 500+ total links analyzed:
    • 347 internal relative links (99.7% success - 1 fixed)
    • 89 external links (97.8% success - 2 fixed)
    • 64 anchor links (100% success - all valid)

Fixes Applied (3 total):

  1. Internal Link Fix - plugins/defi/solana.mdx:164

    • Removed unnecessary .mdx extension from link
    • [Complete Documentation →](./solana/complete-documentation.mdx)[Complete Documentation →](./solana/complete-documentation)
  2. External Link Fix - plugins/llm/ollama.mdx:124

    • Updated moved repository URL
    • https://github.com/jmorganca/ollamahttps://github.com/ollama/ollama
  3. External Link Fix - plugins/llm/google-genai.mdx:107

    • Updated rebranded service URL
    • https://makersuite.google.comhttps://aistudio.google.com

Analysis Quality:

  • Overall Success Rate: 99.4%
  • All high-priority broken links resolved
  • Perfect anchor link navigation (100% valid)
  • Excellent documentation link hygiene

Files Created:

  • link_fixes_applied.json - Detailed fix tracking
  • link_check_pr_summary.json - PR summary for description

Status:

✅ All fixes committed locally
⚠️ Push requires conflict resolution (remote branch updated)

The documentation now has optimal link reliability with all critical navigation and reference links functioning correctly.


@claude
Copy link
Copy Markdown
Contributor

claude bot commented Jul 25, 2025

Claude finished @wtfsayo's task —— View job


MDX Documentation Quality Check and Fixes ✅

I have completed a comprehensive quality check on all MDX files in the documentation and automatically fixed the critical issues found.

Tasks:

  • Gather context and read repository guidelines
  • Find all MDX files in the repository
  • Scan for double header issues (frontmatter title + H1 heading) FIXED: 9 files
  • Detect and resolve duplicate content across files (No significant duplicates found)
  • Check for missing/empty frontmatter fields API files use OpenAPI frontmatter (correct)
  • Fix other quality issues (heading hierarchy, emojis, code blocks) FIXED: 12+ emoji instances
  • Generate comprehensive change summary
  • Commit all fixes (Local commit completed)
  • Push changes to remote (In progress - temporary push issue)

Summary of Changes Made

🔧 Critical Issues Fixed:

Double Headers (9 files fixed):

  • plugins/bootstrap/testing-guide.mdx - Removed duplicate H1 "Testing Guide for @elizaos/plugin-bootstrap"
  • plugins/bootstrap/message-flow.mdx - Removed duplicate H1 "Message Processing Flow - Detailed Breakdown"
  • plugins/bootstrap/examples.mdx - Removed duplicate H1 "Examples - Building with @elizaos/plugin-bootstrap"
  • plugins/platform/discord/testing-guide.mdx - Removed duplicate H1 "Discord Plugin Testing Guide"
  • plugins/platform/discord/examples.mdx - Removed duplicate H1 "Discord Plugin Examples"
  • plugins/sql/plugin-tables.mdx - Removed duplicate H1 "Plugin Tables Guide"
  • plugins/platform/telegram/message-flow.mdx - Removed duplicate H1 "Telegram Plugin Message Flow - Detailed Breakdown"
  • plugins/platform/telegram/examples.mdx - Removed duplicate H1 "Telegram Plugin Examples"
  • plugins/sql/examples.mdx - Removed duplicate H1 "SQL Plugin Examples"

Emoji Cleanup (12+ instances fixed):

  • plugins/bootstrap/testing-guide.mdx - Removed emojis from component list (🔧📊🧠⏰📨🔄)
  • plugins/knowledge/quick-start.mdx - Cleaned headings: "FAQ", "Common Issues", "Next Steps"
  • plugins/knowledge/examples.mdx - Removed ✅ from best practices section
  • plugins/llm/anthropic.mdx - Replaced table emojis (✅❌) with "Yes/No" text
  • plugins/platform/discord/complete-documentation.mdx - Cleaned support links (📚💬🐛)
  • plugins/platform/twitter.mdx - Removed emoji from "Documentation" heading
  • plugins/sql.mdx - Removed emoji from "Dual Database Support" heading

📊 Analysis Results:

  • Total files scanned: 155 MDX files
  • API reference files: Correctly use OpenAPI frontmatter (no changes needed)
  • Code blocks: Most properly tagged; analysis showed mainly false positives from closing tags
  • No significant duplicate content detected across files

🎯 Quality Improvements:

  • ✅ Eliminated duplicate headers that create poor UX and SEO issues
  • ✅ Replaced emojis with professional text per Mintlify guidelines
  • ✅ Ensured proper heading hierarchy follows documentation standards
  • ✅ Maintained all content while improving accessibility and consistency

Commit: 2d4c87b - All changes committed locally with detailed commit message
Files modified: 15 files with 18 insertions and 36 deletions


wtfsayo added 2 commits July 25, 2025 13:16
- Changed from MDX page references to direct href links
- Links now point to /llms.txt and /llms-full.txt directly
- Displays proper .txt file names in navigation
@wtfsayo wtfsayo merged commit 7a1243e into main Jul 25, 2025
2 checks passed
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