Conversation
Signed-off-by: Brendan Graetz <bguiz@users.noreply.github.com>
Signed-off-by: Brendan Graetz <bguiz@users.noreply.github.com>
📝 WalkthroughWalkthroughDocumentation is reorganized under a new AI Developers section with improved navigation. The Developers page title is updated, comprehensive AI tooling documentation is added, and navigation redirects are configured to maintain backward compatibility with the previous URL structure. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
…name mcp to documentation MCP, since we have more than one Signed-off-by: Brendan Graetz <bguiz@users.noreply.github.com>
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In @.gitbook/developers-ai/index.mdx:
- Around line 27-31: Fix the copy defects in the user-facing text by correcting
grammar and hyphenation: change "make them understood or callable by LLMs." to
"makes them understandable or callable by LLMs.", change "i.e. information that
was no available to it when the LLM was trained," to "i.e. information that was
not available to it when the LLM was trained,", and consistently apply
compound-word hyphenation (e.g., "command line interfaces" -> "command-line
interfaces", "real time" -> "real-time", "up to date" -> "up-to-date", "out of
date" -> "out-of-date", "fast moving" -> "fast-moving") across the same document
occurrences (including the other affected snippets referenced); ensure
punctuation and spacing remain correct after edits.
In @.gitbook/docs.json:
- Around line 1224-1231: The redirects JSON missing explicit trailing-slash
variants causes 404s for some paths; update the redirects array to add the
missing entries for both variants by adding entries whose "source" values
include "/developers/ai" and "/developers/ai/mcp/" (and corresponding
"/developers/ai/" and "/developers/ai/mcp") with matching "destination" values
"/developers-ai", "/developers-ai/" and "/developers-ai/documentation-mcp" so
both trailing and non‑trailing forms are covered—look for the existing objects
with "source": "/developers/ai/" and "source": "/developers/ai/mcp" and add the
complementary entries for the other slash variants.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: ac380555-61ed-4625-8487-7dc0fba6c862
📒 Files selected for processing (4)
.gitbook/developers-ai/documentation-mcp.mdx.gitbook/developers-ai/index.mdx.gitbook/developers/index.mdx.gitbook/docs.json
| These can be anything from functions, to scripts, to command line interfaces (CLIs) that are packaged up in a manner | ||
| that make them understood or callable by LLMs. | ||
| For example, if you want the LLM to access real time information, | ||
| i.e. information that was no available to it when the LLM was trained, | ||
| you would need to give it access to call tools for web searches or other data APIs. |
There was a problem hiding this comment.
Fix copy defects in user-facing text (typos + compound adjective hyphenation).
There are multiple grammar/spelling issues that reduce doc quality (e.g., Line [30], Line [42], Line [51], Line [54]) plus repeated missing hyphens (e.g., “command-line”, “real-time”, “up-to-date”, “out-of-date”, “fast-moving”).
✍️ Suggested patch
- These can be anything from functions, to scripts, to command line interfaces (CLIs) that are packaged up in a manner
+ These can be anything from functions, to scripts, to command-line interfaces (CLIs) that are packaged up in a manner
@@
- For example, if you want the LLM to access real time information,
- i.e. information that was no available to it when the LLM was trained,
+ For example, if you want the LLM to access real-time information,
+ i.e. information that was not available to it when the LLM was trained,
@@
- and agents are are sets of workflows and skills.
- Note that the term "agents" is overused, with multiple definitions, so the abogve does not apply in other contexts.
+ and agents are sets of workflows and skills.
+ Note that the term "agents" is overused, with multiple definitions, so the above does not apply in other contexts.
@@
- The operate directly on the file system, and often come with baked in optimisations and utilities for engineering tasks.
+ They operate directly on the file system, and often come with baked-in optimisations and utilities for engineering tasks.
@@
- Popular ones include: Claude Code (Anthropic), Codex (Open AI), and OpenCode (unaffiliated).
+ Popular ones include: Claude Code (Anthropic), Codex (OpenAI), and OpenCode (unaffiliated).
@@
-to obtain up to date information from this documentation site.
+to obtain up-to-date information from this documentation site.
@@
-it will likely give you out of date information, as it does with any fast moving technology.
+it will likely give you out-of-date information, as it does with any fast-moving technology.
@@
-not only will you get up to date information about developing on Injective,
+not only will you get up-to-date information about developing on Injective,Also applies to: 41-42, 51-51, 54-54, 73-75, 79-79
🧰 Tools
🪛 LanguageTool
[grammar] ~27-~27: Use a hyphen to join words.
Context: ...g from functions, to scripts, to command line interfaces (CLIs) that are packaged...
(QB_NEW_EN_HYPHEN)
[grammar] ~29-~29: Use a hyphen to join words.
Context: ...mple, if you want the LLM to access real time information, i.e. information t...
(QB_NEW_EN_HYPHEN)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In @.gitbook/developers-ai/index.mdx around lines 27 - 31, Fix the copy defects
in the user-facing text by correcting grammar and hyphenation: change "make them
understood or callable by LLMs." to "makes them understandable or callable by
LLMs.", change "i.e. information that was no available to it when the LLM was
trained," to "i.e. information that was not available to it when the LLM was
trained,", and consistently apply compound-word hyphenation (e.g., "command line
interfaces" -> "command-line interfaces", "real time" -> "real-time", "up to
date" -> "up-to-date", "out of date" -> "out-of-date", "fast moving" ->
"fast-moving") across the same document occurrences (including the other
affected snippets referenced); ensure punctuation and spacing remain correct
after edits.
| { | ||
| "source": "/developers/ai/", | ||
| "destination": "/developers-ai/" | ||
| }, | ||
| { | ||
| "source": "/developers/ai/mcp", | ||
| "destination": "/developers-ai/documentation-mcp" | ||
| }, |
There was a problem hiding this comment.
🧩 Analysis chain
🌐 Web query:
Mintlify docs.json redirects trailing slash handling configuration
💡 Result:
Mintlify’s docs.json doesn’t have a dedicated “trailing slash handling”/normalization setting for redirects. You only configure redirects via the redirects array with source → destination paths (plus optional wildcard patterns). [1]
What to do instead
- If you need both
/pathand/path/to redirect, add two explicit redirect entries (one for each variant), since Mintlify only documents path-based redirect rules—not a trailing-slash normalization toggle. [1] - Or handle trailing slashes at your hosting/proxy layer:
- On Netlify, redirect matching is effectively trailing-slash-insensitive due to URL normalization at the edge (so a rule for
/fooalso matches/foo/). [2] - On Vercel/other proxies, you’d handle slash canonicalization in that platform’s config (Mintlify’s Vercel guide focuses on rewrites, not slash policy). [3]
- On Netlify, redirect matching is effectively trailing-slash-insensitive due to URL normalization at the edge (so a rule for
Example (docs.json)
{
"redirects": [
{ "source": "/old-path", "destination": "/new-path" },
{ "source": "/old-path/", "destination": "/new-path" }
]
}Also note: in at least one Mintlify setting (“monorepo docs path”), they explicitly say don’t include a trailing slash, which reinforces that slash behavior is generally not controlled by a single global toggle in docs.json. [4]
Sources: Mintlify Redirects docs [1], Netlify trailing slash behavior [2], Mintlify Vercel subpath guide [3], Mintlify monorepo note about no trailing slash [4].
🏁 Script executed:
# Verify the actual content of the .gitbook/docs.json file at the mentioned lines
if [ -f ".gitbook/docs.json" ]; then
echo "=== Checking file size ==="
wc -l .gitbook/docs.json
echo ""
echo "=== Content around lines 1224-1231 ==="
sed -n '1224,1231p' .gitbook/docs.json
else
echo "File not found. Searching for docs.json files..."
fd -t f "docs.json"
fiRepository: InjectiveLabs/injective-docs
Length of output: 356
Add explicit redirect entries for trailing-slash variants to prevent 404s.
Mintlify does not automatically normalize trailing slashes—it only matches the exact path you configure. The current setup has an inconsistency: /developers/ai/ (with slash) is redirected, but /developers/ai/mcp (without slash) lacks a corresponding /developers/ai/mcp/ entry. Add explicit redirects for both variants:
{
"source": "/developers/ai",
"destination": "/developers-ai"
},
{
"source": "/developers/ai/",
"destination": "/developers-ai/"
},
{
"source": "/developers/ai/mcp",
"destination": "/developers-ai/documentation-mcp"
},
{
"source": "/developers/ai/mcp/",
"destination": "/developers-ai/documentation-mcp"
}This ensures both trailing and non-trailing paths are covered.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In @.gitbook/docs.json around lines 1224 - 1231, The redirects JSON missing
explicit trailing-slash variants causes 404s for some paths; update the
redirects array to add the missing entries for both variants by adding entries
whose "source" values include "/developers/ai" and "/developers/ai/mcp/" (and
corresponding "/developers/ai/" and "/developers/ai/mcp") with matching
"destination" values "/developers-ai", "/developers-ai/" and
"/developers-ai/documentation-mcp" so both trailing and non‑trailing forms are
covered—look for the existing objects with "source": "/developers/ai/" and
"source": "/developers/ai/mcp" and add the complementary entries for the other
slash variants.
1 participant
Summary by CodeRabbit