-
Notifications
You must be signed in to change notification settings - Fork 9
Revert: Update and rename intro.md to Glific Overview.md #374 #398
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
WalkthroughUpdated Docusaurus navbar configuration to change the first doc link target from "Glific Overview" to "intro". No other configuration changes. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Possibly related PRs
Poem
Tip 🔌 Remote MCP (Model Context Protocol) integration is now available!Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats. ✨ Finishing Touches
🧪 Generate unit tests
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
|
🚀 Deployed on https://deploy-preview-398--glific-docs.netlify.app |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docusaurus.config.js(1 hunks)
🔇 Additional comments (1)
docusaurus.config.js (1)
67-67: Navbar doc target updated to 'intro' — LGTMThis aligns with the standard Docusaurus default doc id. No issues spotted with the change itself.
| { | ||
| type: "doc", | ||
| docId: "Glific Overview", | ||
| docId: "intro", | ||
| position: "left", | ||
| label: "Documentation", | ||
| }, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
💡 Verification agent
🧩 Analysis chain
Verify the 'intro' doc exists and align related links to avoid 404s
Ensure that a doc with id or filename intro exists (e.g., docs/intro.md or frontmatter id: intro). Also consider aligning other references (e.g., footer link currently pointing to /docs/Introduction) to /docs/intro to avoid broken links if the slug/id changed.
Run this script to verify:
If needed, update the footer Docs link target to the new slug:
- Current: to: "/docs/Introduction"
- Suggested: to: "/docs/intro"
🏁 Script executed:
#!/bin/bash
set -euo pipefail
echo "Looking for docs named intro.md(x):"
fd -a -e md -e mdx --glob "intro.*" || true
echo
echo "Looking for frontmatter id: intro in docs:"
rg -n "^id:\s*intro\b" -t md -t mdx || true
echo
echo "References to '/docs/Introduction' (may need updating to '/docs/intro'):"
rg -n "/docs/Introduction\b" || trueLength of output: 617
Action required — update footer Docs link to match the existing doc slug intro
Found docs/intro.md. docusaurus.config.js contains a footer link pointing to "/docs/Introduction" (line 91) — change it to "/docs/intro" to avoid 404s.
- docs/intro.md — exists (docs/intro.md)
- docusaurus.config.js:91 — currently: to: "/docs/Introduction" → change to: to: "/docs/intro"
Diff suggestion:
- Current: to: "/docs/Introduction"
- Suggested: to: "/docs/intro"
Note: the frontmatter-id search was inconclusive due to ripgrep reporting an mdx file-type warning, but the file-based slug exists and should be used/linked.
🤖 Prompt for AI Agents
In docusaurus.config.js around lines 65-70 (and update the footer entry at line
91), the footer Docs link points to "/docs/Introduction" which doesn't match the
existing doc slug; change the link target to "/docs/intro" to match
docs/intro.md and prevent 404s, and scan the config for any other occurrences of
"/docs/Introduction" and replace them with "/docs/intro".
Summary by CodeRabbit