Skip to content

Commit 01e465b

Browse files
committed
Update README.md to clarify the configuration file requirement and adjust documentation links for improved organization.
1 parent e860391 commit 01e465b

File tree

1 file changed

+3
-14
lines changed

1 file changed

+3
-14
lines changed

README.md

Lines changed: 3 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ my-project/
3838
│ ├── installation.md # Guides
3939
│ └── api/ # Organize in folders
4040
│ └── reference.md
41-
└── knowledge.config.ts # ⚙️ Configuration (optional)
41+
└── knowledge.config.ts # ⚙️ Configuration (required)
4242
```
4343

4444
### 2. **Write in Markdown**
@@ -55,15 +55,12 @@ Welcome! This is a simple example.
5555

5656
## Links
5757

58-
- [Installation](./installation.md)
59-
- [API](./api/reference.md)
58+
- [Installation](./docs/installation.md)
59+
- [API](./docs/reference.md)
6060
```
6161

6262
### 3. **Generate documentation**
6363
```bash
64-
# Development (with live reload)
65-
bun run dev
66-
6764
# Production (static files)
6865
bun run build
6966

@@ -142,9 +139,6 @@ export default {
142139
## 🚀 Essential Commands
143140

144141
```bash
145-
# Development
146-
bun run dev # Start server with live reload
147-
148142
# Production
149143
bun run build # Generate static site
150144
bun run serve # Serve generated files
@@ -180,11 +174,6 @@ docs/
180174
npm install my-project
181175
```
182176

183-
# Add internal links
184-
- [Installation](./installation.md)
185-
- [API](./api/reference.md)
186-
```
187-
188177
### **4. Maintain Consistency**
189178
- Same heading style
190179
- Standard format for examples

0 commit comments

Comments
 (0)