Private. Intelligent. Yours.
This repository contains the official documentation for NEAR AI Cloud, a platform offering developers access to secure, private, verifiable AI models through a unified API.
The site is built and hosted with Mintlify. Content is plain MDX; docs.json holds the navigation, branding, and site settings.
The API Reference tab is generated by Mintlify from api-reference/openapi.json, a vendored copy of the live spec. Refresh it with ./scripts/sync-openapi.py whenever the API changes.
Before you begin, ensure you have the following installed:
- Node.js >= 20.0.0 (Download)
- Mintlify CLI:
npm i -g mint
# Clone the repository
git clone https://github.com/nearai/docs.git
cd docs
# Install the Mintlify CLI (once)
npm i -g mint# Start the local preview
mint devThis starts a local preview at http://localhost:3000. Changes are reflected live without restarting the server.
# Strict build validation (fails on warnings or errors)
mint validate
# Check for broken internal links
mint broken-linksRun both before opening a pull request; CI runs the broken-link check on every PR.
| Command | Description |
|---|---|
mint dev |
Start the local preview with hot reload |
mint validate |
Validate the build in strict mode |
mint broken-links |
Check for broken links |
mint update |
Update the Mintlify CLI |
Mintlify deploys automatically from the main branch through the Mintlify GitHub App; every pull request gets a preview deployment. The production domain (docs.near.ai) is configured in the Mintlify dashboard.
We welcome contributions to improve our documentation! Here's how you can help:
- Fork the repository
- Create a feature branch (
git checkout -b feature/amazing-improvement) - Make your changes and test locally (
mint dev) - Validate (
mint validate && mint broken-links) - Commit your changes (
git commit -m 'Add amazing improvement') - Push to the branch (
git push origin feature/amazing-improvement) - Open a Pull Request
- Use clear, concise language
- Include code examples where applicable
- Follow the existing documentation structure
- Test all code snippets before submitting
- Use proper markdown formatting
- Markdown Files: Use the
.mdxextension; a page's URL is its file path (e.g.,cloud/quickstart.mdx→/cloud/quickstart) - Navigation: Add every new page to the
navigationtree indocs.json - Code Blocks: Include language identifiers for syntax highlighting; add a filename after the language for a title (
```yaml librechat.yaml) - Links: Use absolute paths for internal links (e.g.,
/cloud/quickstart) - Images: Store in
images/and reference with absolute paths (e.g.,/images/cloud.png) - Components: Use Mintlify's built-in components (
Card,CardGroup,Tabs,Accordion,Note/Tip/Warning, …) rather than custom React - Integration guides: Follow the section contract in
.github/INTEGRATION_GUIDE_TEMPLATE.md
Found a bug or have a feature request? Please open an issue with:
- Clear title and description
- Steps to reproduce (for bugs)
- Expected vs actual behavior
- Screenshots (if applicable)
- Documentation: https://docs.near.ai
- NEAR AI Cloud: https://cloud.near.ai
- GitHub: https://github.com/nearai/docs
- Issues: https://github.com/nearai/docs/issues
Need help? Reach out through:
This project is licensed under the MIT License - see the LICENSE file for details.