Skip to content

Commit ded2ca4

Browse files
committed
docs: add devloper section readme and register the db migration checklist
1 parent a7ee7a6 commit ded2ca4

File tree

2 files changed

+14
-0
lines changed

2 files changed

+14
-0
lines changed

docs/SUMMARY.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,8 @@ generator, in this case, **mdbook**. It defines the structure and navigation of
4545
- [Troubleshooting]()
4646
- [Collecting Debug Logs](user-guide/troubleshooting/collecting-debug-logs.md)
4747
- [Find your app version](user-guide/troubleshooting/find-your-app-version.md)
48+
- [Developer](developer/README.md)
49+
- [Database Migration Checklist](developer/db-migration-checklist.md)
4850
- [Release]()
4951
- [Release Process](release/RELEASE.md)
5052
- [Release Automation](release/AUTOMATION.md)

docs/developer/README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Developer Documentation
2+
3+
Developer focused documentation for contributing to the codebase. It's dedicated to providing essential guides,
4+
checklists, and architectural notes to help you navigate the codebase and contribute safely.
5+
6+
## Checklists
7+
8+
Detailed checklists to ensure best practices and consistency across the codebase:
9+
10+
- **[Database Migration Checklist](./db-migration-checklist.md)**
11+
A mandatory checklist for creating and reviewing database migrations to ensure they are safe, performant, and correct.
12+

0 commit comments

Comments
 (0)