@@ -8,6 +8,7 @@ Welcome to the D.A.T.A. (Database Automation, Testing, and Alignment) documentat
8
8
## 📚 Documentation Structure
9
9
10
10
### 🚀 [ Features] ( /docs/features/ )
11
+
11
12
User-facing feature documentation and guides
12
13
13
14
- ** [ Edge Functions Integration] ( features/edge-functions.md ) ** - Deploy and manage Supabase Edge Functions alongside migrations
@@ -16,6 +17,7 @@ User-facing feature documentation and guides
16
17
- Production safety features
17
18
18
19
### ⚙️ [ Configuration] ( /docs/configuration/ )
20
+
19
21
How to configure D.A.T.A. for your project
20
22
21
23
- ** [ Testing Configuration] ( configuration/testing.md ) ** - Configure test execution, coverage, and automation
@@ -24,6 +26,7 @@ How to configure D.A.T.A. for your project
24
26
- Watch mode and auto-compilation settings
25
27
26
28
### 🔮 [ Roadmap] ( /docs/roadmap/ )
29
+
27
30
Future plans and vision for D.A.T.A.
28
31
29
32
- ** [ Ideas and Future Features] ( roadmap/ideas-and-future.md ) ** - The grand vision for D.A.T.A.'s evolution
@@ -32,6 +35,7 @@ Future plans and vision for D.A.T.A.
32
35
- AI-assisted migration intelligence
33
36
34
37
### 🔧 [ Technical] ( /docs/technical/ )
38
+
35
39
Implementation details and architecture documentation
36
40
37
41
- ** [ Memory Management] ( technical/memory-management.md ) ** - How D.A.T.A. handles large test suites
@@ -45,34 +49,39 @@ Implementation details and architecture documentation
45
49
- Migration generation
46
50
47
51
### 🎯 [ Decisions] ( /docs/decisions/ )
52
+
48
53
Architecture Decision Records (ADRs)
49
54
50
55
- ** [ CLI Framework] ( decisions/cli-framework.md ) ** - Why Commander.js was chosen
51
56
- ** [ Event Architecture] ( decisions/event-architecture.md ) ** - Event-driven command pattern
52
57
- ** [ Testing Strategy] ( decisions/testing-strategy.md ) ** - pgTAP and Vitest integration
53
58
54
59
### 📋 [ Tasks] ( /docs/TASKS/ )
60
+
55
61
Task management and project tracking
56
62
57
63
- ** [ System Tasks] ( TASKS/system.md ) ** - Core system improvements and features
58
64
- ** [ Test Tasks] ( TASKS/test.md ) ** - Testing infrastructure and coverage
59
65
- ** [ Migration Tasks] ( TASKS/migration.md ) ** - Migration system enhancements
60
66
61
67
### 🔍 [ Audits] ( /docs/audits/ )
68
+
62
69
Code quality and security audits
63
70
64
71
- Repository structure audits
65
72
- Security review documentation
66
73
- Performance analysis reports
67
74
68
75
### 👀 [ Code Reviews] ( /docs/code-reviews/ )
76
+
69
77
Code review templates and guidelines
70
78
71
79
- Review checklists
72
80
- Best practices documentation
73
81
- Common patterns and anti-patterns
74
82
75
83
### 🖖 [ Fun] ( /docs/fun/ )
84
+
76
85
Star Trek references and easter eggs
77
86
78
87
- ** [ Bridge Crew Personalities] ( fun/personalities.md ) ** - Different personality modes for D.A.T.A.
@@ -82,35 +91,41 @@ Star Trek references and easter eggs
82
91
## 🗺️ Quick Navigation Guide
83
92
84
93
### For New Users
94
+
85
95
1 . Start with [ Edge Functions Integration] ( features/edge-functions.md ) to understand core features
86
96
2 . Review [ Testing Configuration] ( configuration/testing.md ) to set up your project
87
97
3 . Check the main [ README] ( /README.md ) for quick start instructions
88
98
89
99
### For Contributors
100
+
90
101
1 . Read relevant [ Architecture Decisions] ( decisions/ ) to understand design choices
91
102
2 . Review [ Technical Documentation] ( technical/ ) for implementation details
92
103
3 . Check [ Tasks] ( TASKS/ ) for current work items
93
104
4 . Follow [ Code Review Guidelines] ( code-reviews/ ) for contributions
94
105
95
106
### For System Architects
107
+
96
108
1 . Study the [ Golden SQL Compilation Algorithm] ( technical/golden-sql-compilation-algorithm.md )
97
109
2 . Review [ Memory Management] ( technical/memory-management.md ) architecture
98
110
3 . Explore [ Ideas and Future Features] ( roadmap/ideas-and-future.md ) for roadmap planning
99
111
100
112
## 📖 Documentation Standards
101
113
102
114
### File Naming
115
+
103
116
- Use kebab-case for all documentation files
104
117
- Be descriptive but concise (e.g., ` memory-management.md ` not ` mm.md ` )
105
118
- Group related docs in appropriate directories
106
119
107
120
### Content Structure
121
+
108
122
- Start with a clear title and overview
109
123
- Use hierarchical headings (H2 for main sections, H3 for subsections)
110
124
- Include code examples where relevant
111
125
- Add cross-references to related documentation
112
126
113
127
### Maintenance
128
+
114
129
- Keep documentation synchronized with code changes
115
130
- Archive outdated documentation rather than deleting
116
131
- Date significant updates in document headers
@@ -134,12 +149,12 @@ When adding new documentation:
134
149
135
150
## 🔗 External Resources
136
151
137
- - [ Main Repository] ( https://github.com/starfleet/supa-data )
138
- - [ Issue Tracker] ( https://github.com/starfleet/supa-data /issues )
152
+ - [ Main Repository] ( https://github.com/flyingrobots/DATA )
153
+ - [ Issue Tracker] ( https://github.com/flyingrobots/DATA /issues )
139
154
- [ Supabase Documentation] ( https://supabase.com/docs )
140
155
- [ pgTAP Documentation] ( https://pgtap.org/ )
141
156
142
157
---
143
158
144
159
* "The complexity of our documentation structure is directly proportional to the sophistication of our system. Both are... fascinating."*
145
- — Lt. Commander Data, Chief Documentation Officer
160
+ — Lt. Commander Data, Chief Documentation Officer
0 commit comments