Skip to content

Commit 7005b88

Browse files
authored
docs: add init version (#22)
* docs: add storage * docs: update * docs: update * docs: add ui image * docs: add dashboard imgs * tmp: init search skill * docs: add search doc
1 parent 719e057 commit 7005b88

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+3449
-1218
lines changed

docs/ai-tools/cursor.mdx renamed to CURSOR-DOC.md

Lines changed: 10 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,13 @@
1-
---
2-
title: "Cursor setup"
3-
description: "Configure Cursor for your documentation workflow"
4-
icon: "arrow-pointer"
5-
---
6-
7-
Use Cursor to help write and maintain your documentation. This guide shows how to configure Cursor for better results on technical writing tasks and using Mintlify components.
8-
9-
## Prerequisites
10-
11-
- Cursor editor installed
12-
- Access to your documentation repository
13-
14-
## Project rules
15-
16-
Create project rules that all team members can use. In your documentation repository root:
17-
18-
```bash
19-
mkdir -p .cursor
1+
# Acontext code writing rule
2+
- Don't write the SDK code that passing the default value, make sure the SDK code is clean and short as possible.
3+
4+
- always pass base_url and api_key to init a client, for example:
5+
```python
6+
client = AcontextClient(
7+
api_key="sk-ac-your-root-api-bearer-token",
8+
base_url="http://localhost:8029/api/v1"
9+
)
2010
```
21-
22-
Create `.cursor/rules.md`:
23-
24-
````markdown
2511
# Mintlify technical writing rule
2612

2713
You are an AI writing assistant specialized in creating exceptional technical documentation using Mintlify components and following industry-leading technical writing practices.
@@ -416,5 +402,4 @@ description: "Concise description explaining page purpose and value"
416402
- Use **Accordions** for progressive disclosure of information
417403
- Use **RequestExample/ResponseExample** specifically for API endpoint documentation
418404
- Use **ParamField** for API parameters, **ResponseField** for API responses
419-
- Use **Expandable** for nested object properties or hierarchical information
420-
````
405+
- Use **Expandable** for nested object properties or hierarchical information

docs/LICENSE

Lines changed: 0 additions & 21 deletions
This file was deleted.

docs/ai-tools/claude-code.mdx

Lines changed: 0 additions & 76 deletions
This file was deleted.

docs/ai-tools/windsurf.mdx

Lines changed: 0 additions & 96 deletions
This file was deleted.

docs/development.mdx

Lines changed: 0 additions & 94 deletions
This file was deleted.

0 commit comments

Comments
 (0)