Skip to content

Commit 4101820

Browse files
committed
chore(docs) formatting
1 parent 5726d4e commit 4101820

File tree

3 files changed

+22
-12
lines changed

3 files changed

+22
-12
lines changed

docs/README.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -151,14 +151,17 @@ This directory contains comprehensive guides for using, developing, testing, and
151151

152152
When contributing documentation:
153153

154-
1. Follow the existing structure and style
155-
2. Use proper Markdown formatting
156-
3. Include code examples where appropriate
157-
4. Test all commands and configurations
158-
5. Keep documentation up to date with code changes
159-
6. Cross-reference related documents
160-
161-
See: [Contributing](contributing) for more details
154+
> [!TIP]
155+
>
156+
> 1. Follow the existing structure and style
157+
> 2. Use proper Markdown formatting
158+
> 3. Include code examples where appropriate
159+
> 4. Test all commands and configurations
160+
> 5. Keep documentation up to date with code changes
161+
> 6. Cross-reference related documents
162+
163+
> [!NOTE]
164+
> See: [Contributing](contributing) for more details
162165
163166
## Getting Help
164167

docs/building-and-developing.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -233,7 +233,9 @@ npm run server [port] [options]
233233

234234
- Starts Node.js collaboration server
235235
- Default port: 1337
236-
- See [collaboration-server.md](collaboration-server.md) for options
236+
237+
> [!NOTE]
238+
> See [collaboration-server.md](collaboration-server.md) for options
237239
238240
### Code Quality Scripts
239241

@@ -307,7 +309,9 @@ npm run test:unit
307309

308310
- Runs Vitest unit tests
309311
- Generates coverage report
310-
- See [testing.md](testing.md) for details
312+
313+
> [!NOTE]
314+
> See [testing.md](testing.md) for details
311315
312316
**`bun test:e2e`** - Run end-to-end tests
313317

@@ -319,7 +323,9 @@ npm run test:e2e
319323

320324
- Runs Playwright E2E tests
321325
- Tests in Chrome, Firefox, WebKit
322-
- See [testing.md](testing.md) for details
326+
327+
> [!NOTE]
328+
> See [testing.md](testing.md) for details
323329
324330
**`bun test:install`** - Install test dependencies
325331

docs/project-structure.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -675,7 +675,8 @@ tests/
675675
└── wiki.yml # Wiki documentation sync
676676
```
677677

678-
See [CI/CD Pipeline](cicd.md) for detailed workflow documentation.
678+
> [!INFO]
679+
> See [CI/CD Pipeline](cicd.md) for detailed workflow documentation.
679680
680681
## Build Output
681682

0 commit comments

Comments
 (0)