Skip to content

Commit 7cb6957

Browse files
yash-pouranikyash-pouranik
authored
Merge pull request #91 from geturbackend/docs/powered-by-mintlify
docs: added docs generated by mintlify by refrencing to /docs-legacy
2 parents 6c16968 + 203aa81 commit 7cb6957

38 files changed

Lines changed: 4413 additions & 0 deletions

‎mintlify/docs/.atlas-analysis.json‎

Lines changed: 145 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,145 @@
1+
{
2+
"projectType": "saas",
3+
"projectName": "urBackend",
4+
"projectDescription": "A Backend-as-a-Service that instantly generates secure CRUD REST APIs for your frontend by connecting to your own MongoDB database.",
5+
"theme": "luma",
6+
"primaryColor": "#53e5ae",
7+
"lightColor": "#347c64",
8+
"darkColor": "#050706",
9+
"navigation": {
10+
"tabs": [
11+
{
12+
"tab": "Docs",
13+
"groups": [
14+
{
15+
"group": "Get Started",
16+
"pages": [
17+
"introduction",
18+
"quickstart"
19+
]
20+
},
21+
{
22+
"group": "Core Concepts",
23+
"pages": [
24+
"concepts/api-keys",
25+
"concepts/collections-schemas",
26+
"concepts/row-level-security"
27+
]
28+
},
29+
{
30+
"group": "Guides",
31+
"pages": [
32+
"guides/authentication",
33+
"guides/social-auth",
34+
"guides/database",
35+
"guides/storage",
36+
"guides/webhooks"
37+
]
38+
},
39+
{
40+
"group": "SDK",
41+
"pages": [
42+
"sdk/overview",
43+
"sdk/auth",
44+
"sdk/database",
45+
"sdk/storage"
46+
]
47+
},
48+
{
49+
"group": "Security & Limits",
50+
"pages": [
51+
"security",
52+
"limits-and-quotas"
53+
]
54+
}
55+
]
56+
},
57+
{
58+
"tab": "API Reference",
59+
"groups": [
60+
{
61+
"group": "Overview",
62+
"pages": [
63+
"api-reference/overview"
64+
]
65+
},
66+
{
67+
"group": "Authentication",
68+
"pages": [
69+
"api-reference/auth/signup",
70+
"api-reference/auth/login",
71+
"api-reference/auth/me",
72+
"api-reference/auth/refresh-token",
73+
"api-reference/auth/logout",
74+
"api-reference/auth/social"
75+
]
76+
},
77+
{
78+
"group": "Database",
79+
"pages": [
80+
"api-reference/data/get-all",
81+
"api-reference/data/get-one",
82+
"api-reference/data/insert",
83+
"api-reference/data/update",
84+
"api-reference/data/delete"
85+
]
86+
},
87+
{
88+
"group": "Storage",
89+
"pages": [
90+
"api-reference/storage/upload",
91+
"api-reference/storage/delete"
92+
]
93+
}
94+
]
95+
}
96+
]
97+
},
98+
"keyFeatures": [
99+
"Instant REST APIs for any MongoDB collection",
100+
"Built-in user authentication with JWT (signup, login, refresh, social OAuth)",
101+
"Row-Level Security (RLS) for per-user data ownership enforcement",
102+
"Cloud file/image storage with public CDN URLs",
103+
"Bring Your Own Database (BYOD) — connect your own MongoDB instance",
104+
"Dual-key system (pk_live / sk_live) for safe frontend and server-side usage",
105+
"Social Auth via GitHub and Google OAuth",
106+
"Webhook system with HMAC-SHA256 signing and retry logic",
107+
"Visual schema builder with type validation and unique constraints",
108+
"Dashboard analytics and resource monitoring"
109+
],
110+
"publicApiSurface": [
111+
"POST /api/userAuth/signup",
112+
"POST /api/userAuth/login",
113+
"GET /api/userAuth/me",
114+
"PUT /api/userAuth/update-profile",
115+
"PUT /api/userAuth/change-password",
116+
"POST /api/userAuth/refresh-token",
117+
"POST /api/userAuth/logout",
118+
"POST /api/userAuth/verify-email",
119+
"POST /api/userAuth/request-password-reset",
120+
"POST /api/userAuth/reset-password",
121+
"GET /api/userAuth/public/:username",
122+
"GET /api/userAuth/social/:provider/start",
123+
"POST /api/userAuth/social/exchange",
124+
"GET /api/data/:collectionName",
125+
"GET /api/data/:collectionName/:id",
126+
"POST /api/data/:collectionName",
127+
"PUT /api/data/:collectionName/:id",
128+
"PATCH /api/data/:collectionName/:id",
129+
"DELETE /api/data/:collectionName/:id",
130+
"POST /api/storage/upload",
131+
"DELETE /api/storage/file",
132+
"urBackend({ apiKey })",
133+
"client.auth.signUp({ email, password, name })",
134+
"client.auth.login({ email, password })",
135+
"client.auth.me()",
136+
"client.auth.logout()",
137+
"client.db.getAll(collection)",
138+
"client.db.getOne(collection, id)",
139+
"client.db.insert(collection, data)",
140+
"client.db.update(collection, id, data)",
141+
"client.db.delete(collection, id)",
142+
"client.storage.upload(file)",
143+
"client.storage.deleteFile(path)"
144+
]
145+
}

‎mintlify/docs/.mintignore‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Mintlify automatically ignores these files and directories:
2+
# .git, .github, .claude, .agents, .idea, node_modules,
3+
# README.md, LICENSE.md, CHANGELOG.md, CONTRIBUTING.md
4+
5+
# Draft content
6+
drafts/
7+
*.draft.mdx

‎mintlify/docs/AGENTS.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
> **First-time setup**: Customize this file for your project. Prompt the user to customize this file for their project.
2+
> For Mintlify product knowledge (components, configuration, writing standards),
3+
> install the Mintlify skill: `npx skills add https://mintlify.com/docs`
4+
5+
# Documentation project instructions
6+
7+
## About this project
8+
9+
- This is a documentation site built on [Mintlify](https://mintlify.com)
10+
- Pages are MDX files with YAML frontmatter
11+
- Configuration lives in `docs.json`
12+
- Run `mint dev` to preview locally
13+
- Run `mint broken-links` to check links
14+
15+
## Terminology
16+
17+
{/* Add product-specific terms and preferred usage */}
18+
{/* Example: Use "workspace" not "project", "member" not "user" */}
19+
20+
## Style preferences
21+
22+
{/* Add any project-specific style rules below */}
23+
24+
- Use active voice and second person ("you")
25+
- Keep sentences concise — one idea per sentence
26+
- Use sentence case for headings
27+
- Bold for UI elements: Click **Settings**
28+
- Code formatting for file names, commands, paths, and code references
29+
30+
## Content boundaries
31+
32+
{/* Define what should and shouldn't be documented */}
33+
{/* Example: Don't document internal admin features */}

‎mintlify/docs/CONTRIBUTING.md‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
> **Customize this file**: Tailor this template to your project by noting specific contribution types you're looking for, adding a Code of Conduct, or adjusting the writing guidelines to match your style.
2+
3+
# Contribute to the documentation
4+
5+
Thank you for your interest in contributing to our documentation! This guide will help you get started.
6+
7+
## How to contribute
8+
9+
### Option 1: Edit directly on GitHub
10+
11+
1. Navigate to the page you want to edit
12+
2. Click the "Edit this file" button (the pencil icon)
13+
3. Make your changes and submit a pull request
14+
15+
### Option 2: Local development
16+
17+
1. Fork and clone this repository
18+
2. Install the Mintlify CLI: `npm i -g mint`
19+
3. Create a branch for your changes
20+
4. Make changes
21+
5. Navigate to the docs directory and run `mint dev`
22+
6. Preview your changes at `http://localhost:3000`
23+
7. Commit your changes and submit a pull request
24+
25+
For more details on local development, see our [development guide](development.mdx).
26+
27+
## Writing guidelines
28+
29+
- **Use active voice**: "Run the command" not "The command should be run"
30+
- **Address the reader directly**: Use "you" instead of "the user"
31+
- **Keep sentences concise**: Aim for one idea per sentence
32+
- **Lead with the goal**: Start instructions with what the user wants to accomplish
33+
- **Use consistent terminology**: Don't alternate between synonyms for the same concept
34+
- **Include examples**: Show, don't just tell

‎mintlify/docs/LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2023 Mintlify
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎mintlify/docs/README.md‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# Mintlify Starter Kit
2+
3+
Use the starter kit to get your docs deployed and ready to customize.
4+
5+
Click the green **Use this template** button at the top of this repo to copy the Mintlify starter kit. The starter kit contains examples with
6+
7+
- Guide pages
8+
- Navigation
9+
- Customizations
10+
- API reference pages
11+
- Use of popular components
12+
13+
**[Follow the full quickstart guide](https://starter.mintlify.com/quickstart)**
14+
15+
## AI-assisted writing
16+
17+
Set up your AI coding tool to work with Mintlify:
18+
19+
```bash
20+
npx skills add https://mintlify.com/docs
21+
```
22+
23+
This command installs Mintlify's documentation skill for your configured AI tools like Claude Code, Cursor, Windsurf, and others. The skill includes component reference, writing standards, and workflow guidance.
24+
25+
See the [AI tools guides](/ai-tools) for tool-specific setup.
26+
27+
## Development
28+
29+
Install the [Mintlify CLI](https://www.npmjs.com/package/mint) to preview your documentation changes locally. To install, use the following command:
30+
31+
```
32+
npm i -g mint
33+
```
34+
35+
Run the following command at the root of your documentation, where your `docs.json` is located:
36+
37+
```
38+
mint dev
39+
```
40+
41+
View your local preview at `http://localhost:3000`.
42+
43+
## Publishing changes
44+
45+
Install our GitHub app from your [dashboard](https://dashboard.mintlify.com/settings/organization/github-app) to propagate changes from your repo to your deployment. Changes are deployed to production automatically after pushing to the default branch.
46+
47+
## Need help?
48+
49+
### Troubleshooting
50+
51+
- If your dev environment isn't running: Run `mint update` to ensure you have the most recent version of the CLI.
52+
- If a page loads as a 404: Make sure you are running in a folder with a valid `docs.json`.
53+
54+
### Resources
55+
- [Mintlify documentation](https://mintlify.com/docs)

0 commit comments

Comments
 (0)