feat(lingo): Added lingo dev setup and added es language #142
Conversation
WalkthroughConfiguration and documentation updates introducing multi-language navigation support. The docs.json file restructures navigation into language-specific trees for English and Spanish, with all redirects updated to language-prefixed paths. The .gitignore file adds .env to ignored files. Two new Spanish API reference documentation files for addon operations are added. Changes
Estimated code review effort🎯 4 (Complex) | ⏱️ ~45 minutes
Poem
Pre-merge checks and finishing touches❌ Failed checks (2 warnings)
✅ Passed checks (1 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
Tip 📝 Customizable high-level summaries are now available in beta!You can now customize how CodeRabbit generates the high-level summary in your pull requests — including its content, structure, tone, and formatting.
Example instruction:
Note: This feature is currently in beta for Pro-tier users, and pricing will be announced later. 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
.gitignore(1 hunks)docs.json(2 hunks)es/api-reference/addons/create-addon.mdx(1 hunks)es/api-reference/addons/get-addon.mdx(1 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
**/*.{md,mdx}
📄 CodeRabbit inference engine (.cursor/rules/mintlify.mdc)
Every documentation page must begin with YAML frontmatter containing title and description
Files:
es/api-reference/addons/create-addon.mdxes/api-reference/addons/get-addon.mdx
**/*.mdx
📄 CodeRabbit inference engine (.cursor/rules/mintlify.mdc)
**/*.mdx: Use clear, direct language appropriate for technical audiences
Write instructions in second person (you)
Use active voice over passive voice
Use present tense for current states and future tense for outcomes
Maintain consistent terminology across documentation
Keep sentences concise while preserving necessary context
Use parallel structure in lists, headings, and procedures
Lead sections with the most important information (inverted pyramid)
Use progressive disclosure: introduce basics before advanced topics
Break complex procedures into numbered steps using /
Include prerequisites and context before instructions
Provide expected outcomes for each major step
End sections with next steps or related information
Use descriptive, keyword-rich headings for navigation and SEO
Focus on user goals and outcomes rather than system features
Anticipate common questions and address them proactively
Include troubleshooting for likely failure points
Provide multiple pathways (beginner vs advanced) when appropriate, with an opinionated recommended path
Use for supplementary information that supports main content
Use for expert advice, shortcuts, or best practices
Use for critical cautions, breaking changes, or destructive actions
Use for neutral background or contextual information
Use for success confirmations or achievement indicators
Use to present the same concept in multiple languages
Provide complete, runnable code examples with language specified and filename when relevant
Include RequestExample/ResponseExample blocks for API endpoint docs
Document API parameters using (path, query, header, body) with types and required/defaults
Document API responses using with names, types, and required flags
Use for nested object properties or hierarchical information
Use / for platform-specific or alternative approaches
Use / for suppl...
Files:
es/api-reference/addons/create-addon.mdxes/api-reference/addons/get-addon.mdx
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Mintlify Deployment
🔇 Additional comments (5)
.gitignore (1)
1-3: LGTM!Adding
.envto.gitignoreis a sensible security practice to prevent accidental commits of environment configuration.docs.json (3)
1361-1634: Verify redirect strategy aligns with language-prefixed content migration.All redirects now point to
/en/prefixed paths, establishing English as the default fallback. Ensure that:
- All English content pages have been migrated from root-level paths (e.g.,
/features/...) toen/paths (e.g.,/en/features/...), or- Legacy redirects from root paths to
en/paths are comprehensive, or- The codebase still serves content from root-level paths for backward compatibility.
Otherwise, links in old documentation, bookmarks, or external references may break.
2-2: JSON syntax is valid—no changes needed.The verification confirms that
docs.jsonpasses JSON validation with no syntax errors. The file is ready for merge.
12-1299: All Spanish content pages are properly implemented and complete.Verification confirms that all 260 Spanish pages referenced in docs.json exist in the
es/directory with full parity to English content. Both language blocks achieve 100% coverage: all pages referenced indocs.jsonnavigation are present as.mdxfiles in their respective language directories (en/andes/). The restructuring successfully supports multi-language navigation without broken links.Likely an incorrect or invalid review comment.
es/api-reference/addons/create-addon.mdx (1)
1-6: Review comment is incorrect.The file correctly follows the codebase pattern for OpenAPI reference documentation. All API reference files (both English and Spanish) in the repository contain only YAML frontmatter with no markdown body—this is the intended format. The OpenAPI metadata is processed by the documentation system to generate endpoint documentation automatically. The file
es/api-reference/addons/create-addon.mdxis complete and consistent with comparable files likeen/api-reference/addons/create-addon.mdx,en/api-reference/addons/get-addon.mdx, and others. No changes are required.Likely an incorrect or invalid review comment.
| --- | ||
| openapi: get /addons/{id} | ||
| title: Obtener Complemento | ||
| description: Recuperar información detallada sobre un complemento específico | ||
| utilizando su identificador único | ||
| --- No newline at end of file |
There was a problem hiding this comment.
🧩 Analysis chain
Document body is missing after frontmatter.
Like the create-addon file, this API reference contains only YAML frontmatter with no markdown content following the closing --- delimiter. Ensure documentation content is added before merging.
🏁 Script executed:
#!/bin/bash
# Check content of both addon files to verify if they contain only frontmatter
echo "=== get-addon.mdx content ==="
cat es/api-reference/addons/get-addon.mdx | head -50
echo -e "\n=== create-addon.mdx content (for comparison) ==="
cat es/api-reference/addons/create-addon.mdx | head -50
echo -e "\n=== File line counts ==="
wc -l es/api-reference/addons/get-addon.mdx es/api-reference/addons/create-addon.mdxLength of output: 533
Correct file line count in review; core issue verified.
The files are indeed incomplete—both contain only YAML frontmatter with no markdown content following the closing --- delimiter. However, the file is 5 lines, not 6. Update the line reference from "Lines: 1-6" to "Lines: 1-5" to be accurate.
🤖 Prompt for AI Agents
In es/api-reference/addons/get-addon.mdx around lines 1 to 5, the file contains
only YAML frontmatter and the review's line range is incorrect; update the
review metadata (or PR comment) to reference lines 1-5 instead of 1-6 so the
file range is accurate, and leave the file content as-is (or add the missing
markdown body in a separate change).
📋 Description
🎯 Type of Change
📖 What documentation does this PR affect?
✅ Checklist
mintlify devdocs.json(if applicable)🧪 Testing
📸 Screenshots (if applicable)
🔗 Related Issues
Closes #
📝 Additional Notes
👥 Reviewers
@dodopayments/documentation-team
Summary by CodeRabbit
New Features
Documentation
✏️ Tip: You can customize this high-level summary in your review settings.