Skip to content

Commit 1a4ea86

Browse files
committed
fix(rules): error in markdown
1 parent b4e1ccb commit 1a4ea86

File tree

2 files changed

+38
-38
lines changed

2 files changed

+38
-38
lines changed

llm-rules.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
id: llm-rules
3+
title: LLM Rules
4+
descriptions: Use Manifest rules in your AI Code Editor to improve your LLM understanding of Manifest backend.
5+
---
6+
7+
# LLM rules
8+
9+
Rules are predefined guidelines and constraints that steer an AI assistant’s behavior. They specify the style, conventions, best practices, or security policies to follow. Rules ensure consistency, quality, and compliance of the generated suggestions.
10+
11+
## Usage
12+
13+
Running the install command above will add the rules to the Manifest rules in your project.
14+
15+
```bash
16+
# Example: install for Cursor AI Code Editor
17+
npm create manifest --cursor
18+
```
19+
20+
You can replace `--cursor` with another option if you're using a different AI tool;
21+
22+
- `--copilot` if you're using GitHub Copilot
23+
- `--windsurf` for Windsurf
24+
25+
If you need to install rules manually, download the file below and add it to your AI code editor:
26+
27+
<a href="https://raw.githubusercontent.com/mnfst/rules/refs/heads/main/src/rules.md" download>
28+
⬇️ Download Manifest Rules
29+
</a>
30+
31+
## Types and OpenAPI Generation
32+
33+
When you run Manifest, it generates 2 key context files in the **/.manifest** folder:
34+
35+
- **openapi.yml**: [OpenAPI](https://www.openapis.org/) spec for the available endpoints, schemas, and the API base URL of your backend.
36+
- **types.ts**: type file with typings and DTOs (Data Transfer Object) for each entity.
37+
38+
By including these context files, Manifest ensures your AI code editor understands your API, enabling smarter and more reliable code generation,especially when you want to connect a frontend to your Manifest backend.

manifest-ai-rules.md

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

0 commit comments

Comments
 (0)