Skip to content

Commit 8973148

Browse files
boojackcursoragent
boojack
and
cursoragent
authored
chore: add AGENTS.md with Cursor Cloud development environment instructions (#262)
* Add AGENTS.md with Cursor Cloud specific instructions Co-authored-by: boojack <stevenlgtm@gmail.com> * Update auto-generated OpenAPI spec and API docs from upstream Co-authored-by: boojack <stevenlgtm@gmail.com> --------- Co-authored-by: Cursor Agent <cursoragent@cursor.com>
1 parent 6d8de33 commit 8973148

6 files changed

Lines changed: 192 additions & 1 deletion

File tree

‎AGENTS.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# AGENTS.md
2+
3+
## Cursor Cloud specific instructions
4+
5+
This is a **Next.js 16 static marketing/docs website** for Memos (usememos.com). No external services, databases, or environment variables are required.
6+
7+
### Services
8+
9+
| Service | Command | Port | Notes |
10+
|---------|---------|------|-------|
11+
| Dev server | `pnpm dev` | 3000 | Uses Turbopack; hot-reloads on file changes |
12+
13+
### Key commands
14+
15+
Refer to `CLAUDE.md` and `package.json` scripts for the full list. Quick reference:
16+
17+
- **Lint**: `pnpm lint` (runs Biome)
18+
- **Format**: `pnpm format` (runs Biome format with `--write`)
19+
- **Build**: `pnpm build` (full production build, generates 300+ static pages)
20+
- **Dev**: `pnpm dev` (starts on port 3000 with Turbopack)
21+
22+
### Gotchas
23+
24+
- The `postinstall` script downloads OpenAPI specs from GitHub (`raw.githubusercontent.com`) and generates MDX + Fumadocs source files. If the network fetch fails during `pnpm install`, the generated API docs will be missing. Rerun `pnpm install` to retry.
25+
- pnpm may warn about ignored build scripts for `esbuild` and `sharp`. This warning is cosmetic and does not block development or builds.
26+
- There are no automated test suites (no `test` script in `package.json`). Verification is done via `pnpm lint` and `pnpm build`.
27+
- The `.source/` directory is auto-generated by `fumadocs-mdx` during `postinstall`. Do not edit files in it directly.

‎content/docs/api/latest/attachmentservice/BatchDeleteAttachments.mdx‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: Batch Delete Attachments
3+
description: BatchDeleteAttachments deletes multiple attachments in one request.
4+
_openapi:
5+
method: POST
6+
toc: []
7+
structuredData:
8+
headings: []
9+
contents:
10+
- content: BatchDeleteAttachments deletes multiple attachments in one request.
11+
---
12+
13+
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
14+
15+
<APIPage document={"./openapi/latest.yaml"} operations={[{"path":"/api/v1/attachments:batchDelete","method":"post"}]} />

‎content/docs/api/latest/attachmentservice/meta.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
{
22
"title": "Attachment Service",
3-
"pages": ["CreateAttachment", "DeleteAttachment", "GetAttachment", "ListAttachments", "UpdateAttachment"]
3+
"pages": ["BatchDeleteAttachments", "CreateAttachment", "DeleteAttachment", "GetAttachment", "ListAttachments", "UpdateAttachment"]
44
}

‎content/docs/api/latest/userservice/BatchGetUsers.mdx‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: Batch Get Users
3+
description: BatchGetUsers returns active users by usernames.
4+
_openapi:
5+
method: POST
6+
toc: []
7+
structuredData:
8+
headings: []
9+
contents:
10+
- content: BatchGetUsers returns active users by usernames.
11+
---
12+
13+
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
14+
15+
<APIPage document={"./openapi/latest.yaml"} operations={[{"path":"/api/v1/users:batchGet","method":"post"}]} />

‎content/docs/api/latest/userservice/meta.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
{
22
"title": "User Service",
33
"pages": [
4+
"BatchGetUsers",
45
"CreatePersonalAccessToken",
56
"CreateUser",
67
"CreateUserWebhook",

‎openapi/latest.yaml‎

Lines changed: 133 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -176,6 +176,28 @@ paths:
176176
application/json:
177177
schema:
178178
$ref: '#/components/schemas/Status'
179+
/api/v1/attachments:batchDelete:
180+
post:
181+
tags:
182+
- AttachmentService
183+
description: BatchDeleteAttachments deletes multiple attachments in one request.
184+
operationId: AttachmentService_BatchDeleteAttachments
185+
requestBody:
186+
content:
187+
application/json:
188+
schema:
189+
$ref: '#/components/schemas/BatchDeleteAttachmentsRequest'
190+
required: true
191+
responses:
192+
"200":
193+
description: OK
194+
content: {}
195+
default:
196+
description: Default error response
197+
content:
198+
application/json:
199+
schema:
200+
$ref: '#/components/schemas/Status'
179201
/api/v1/auth/me:
180202
get:
181203
tags:
@@ -1955,6 +1977,31 @@ paths:
19551977
application/json:
19561978
schema:
19571979
$ref: '#/components/schemas/Status'
1980+
/api/v1/users:batchGet:
1981+
post:
1982+
tags:
1983+
- UserService
1984+
description: BatchGetUsers returns active users by usernames.
1985+
operationId: UserService_BatchGetUsers
1986+
requestBody:
1987+
content:
1988+
application/json:
1989+
schema:
1990+
$ref: '#/components/schemas/BatchGetUsersRequest'
1991+
required: true
1992+
responses:
1993+
"200":
1994+
description: OK
1995+
content:
1996+
application/json:
1997+
schema:
1998+
$ref: '#/components/schemas/BatchGetUsersResponse'
1999+
default:
2000+
description: Default error response
2001+
content:
2002+
application/json:
2003+
schema:
2004+
$ref: '#/components/schemas/Status'
19582005
/api/v1/users:stats:
19592006
get:
19602007
tags:
@@ -2015,6 +2062,33 @@ components:
20152062
description: |-
20162063
Optional. The related memo. Refer to `Memo.name`.
20172064
Format: memos/{memo}
2065+
motionMedia:
2066+
allOf:
2067+
- $ref: '#/components/schemas/MotionMedia'
2068+
description: Optional. Motion media metadata.
2069+
BatchDeleteAttachmentsRequest:
2070+
required:
2071+
- names
2072+
type: object
2073+
properties:
2074+
names:
2075+
type: array
2076+
items:
2077+
type: string
2078+
BatchGetUsersRequest:
2079+
type: object
2080+
properties:
2081+
usernames:
2082+
type: array
2083+
items:
2084+
type: string
2085+
BatchGetUsersResponse:
2086+
type: object
2087+
properties:
2088+
users:
2089+
type: array
2090+
items:
2091+
$ref: '#/components/schemas/User'
20182092
Color:
20192093
type: object
20202094
properties:
@@ -2781,6 +2855,30 @@ components:
27812855
type: string
27822856
description: The title extracted from the first H1 heading, if present.
27832857
description: Computed properties of a memo.
2858+
MotionMedia:
2859+
type: object
2860+
properties:
2861+
family:
2862+
enum:
2863+
- MOTION_MEDIA_FAMILY_UNSPECIFIED
2864+
- APPLE_LIVE_PHOTO
2865+
- ANDROID_MOTION_PHOTO
2866+
type: string
2867+
format: enum
2868+
role:
2869+
enum:
2870+
- MOTION_MEDIA_ROLE_UNSPECIFIED
2871+
- STILL
2872+
- VIDEO
2873+
- CONTAINER
2874+
type: string
2875+
format: enum
2876+
groupId:
2877+
type: string
2878+
presentationTimestampUs:
2879+
type: string
2880+
hasEmbeddedVideo:
2881+
type: boolean
27842882
NotificationSetting_EmailSetting:
27852883
type: object
27862884
properties:
@@ -3133,6 +3231,11 @@ components:
31333231
description: |-
31343232
The sender of the notification.
31353233
Format: users/{user}
3234+
senderUser:
3235+
readOnly: true
3236+
allOf:
3237+
- $ref: '#/components/schemas/User'
3238+
description: The sender user details.
31363239
status:
31373240
enum:
31383241
- STATUS_UNSPECIFIED
@@ -3151,13 +3254,18 @@ components:
31513254
enum:
31523255
- TYPE_UNSPECIFIED
31533256
- MEMO_COMMENT
3257+
- MEMO_MENTION
31543258
type: string
31553259
description: The type of the notification.
31563260
format: enum
31573261
memoComment:
31583262
readOnly: true
31593263
allOf:
31603264
- $ref: '#/components/schemas/UserNotification_MemoCommentPayload'
3265+
memoMention:
3266+
readOnly: true
3267+
allOf:
3268+
- $ref: '#/components/schemas/UserNotification_MemoMentionPayload'
31613269
UserNotification_MemoCommentPayload:
31623270
type: object
31633271
properties:
@@ -3171,6 +3279,31 @@ components:
31713279
description: |-
31723280
The name of related memo.
31733281
Format: memos/{memo}
3282+
memoSnippet:
3283+
type: string
3284+
description: Preview text of the comment memo.
3285+
relatedMemoSnippet:
3286+
type: string
3287+
description: Preview text of the related memo.
3288+
UserNotification_MemoMentionPayload:
3289+
type: object
3290+
properties:
3291+
memo:
3292+
type: string
3293+
description: |-
3294+
The memo that contains the mention.
3295+
Format: memos/{memo}
3296+
relatedMemo:
3297+
type: string
3298+
description: |-
3299+
The related parent memo when the mention was created in a comment.
3300+
Format: memos/{memo}
3301+
memoSnippet:
3302+
type: string
3303+
description: Preview text of the memo that contains the mention.
3304+
relatedMemoSnippet:
3305+
type: string
3306+
description: Preview text of the related parent memo.
31743307
UserSetting:
31753308
type: object
31763309
properties:

0 commit comments

Comments
 (0)