Skip to content

Commit 8aad539

Browse files
author
CIS Guru
committed
docs: Add cross-references between README, Database Management Guide, and Compatibility Matrix
- Link Quick Start Guide from README First Run section - Add Database Management Guide link in README System Requirements - Link Compatibility Matrix from Database Management Guide schema version sections - Link Compatibility Matrix from auto-migration and version upgrade sections - Improve documentation navigation and version compatibility awareness
1 parent de544f5 commit 8aad539

2 files changed

Lines changed: 23 additions & 7 deletions

File tree

Documentation/Database-Management-Guide.md

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -114,10 +114,15 @@ When you upgrade Aquiis SimpleStart to a new version:
114114

115115
**No manual intervention required** - migrations are automatic and seamless!
116116

117+
**Version Upgrade Compatibility:**
118+
Not all version upgrades are supported automatically. Check the **[Compatibility Matrix](Compatibility-Matrix.md)** before upgrading to see if your current version can auto-migrate to the target version, or if manual steps are required.
119+
117120
#### Migration to v1.1.0
118121

119122
When upgrading from v1.0.0 to v1.1.0, the following schema changes are automatically applied:
120123

124+
> **Note:** For complete version compatibility information and upgrade paths, see the **[Compatibility Matrix](Compatibility-Matrix.md)**.
125+
121126
**New Tables:**
122127

123128
- **DatabaseSettings** - Tracks encryption state and configuration
@@ -150,6 +155,9 @@ When upgrading from v1.0.0 to v1.1.0, the following schema changes are automatic
150155

151156
**Important:** v1.1.0 application **requires** v1.1.0 database schema - the DatabaseSettings table is queried on startup. Running v1.1.0 app with v1.0.0 database will result in an error.
152157

158+
**Version Compatibility:**
159+
See the **[Compatibility Matrix](Compatibility-Matrix.md)** for detailed information about which app versions work with which database versions, and whether automatic migration is available.
160+
153161
---
154162

155163
## 🔐 Backup Procedures
@@ -972,13 +980,13 @@ The compiled model lives in `1-Aquiis.Infrastructure/Data/CompiledModels/` and i
972980

973981
**When to regenerate the compiled model:**
974982

975-
| Change | Re-run optimize? |
976-
|---|---|
977-
| Add / remove entity or property | ✅ Yes |
978-
| Add / modify relationship or index | ✅ Yes |
979-
| Rename entity or property | ✅ Yes |
980-
| Data-only migration (seed data, no schema change) | ❌ No |
981-
| Bug fix with no model changes | ❌ No |
983+
| Change | Re-run optimize? |
984+
| ------------------------------------------------- | ---------------- |
985+
| Add / remove entity or property | ✅ Yes |
986+
| Add / modify relationship or index | ✅ Yes |
987+
| Rename entity or property | ✅ Yes |
988+
| Data-only migration (seed data, no schema change) | ❌ No |
989+
| Bug fix with no model changes | ❌ No |
982990

983991
> **Note:** If the compiled model is stale, EF Core throws an `InvalidOperationException` at startup — the app will not silently use wrong metadata.
984992

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -144,6 +144,8 @@ Get-FileHash "Aquiis-1.1.0-x64-Setup.exe" -Algorithm SHA256
144144
3. Register your **first user account**
145145
4. Start managing properties!
146146

147+
**New to Aquiis?** Follow our **[Quick Start Guide](Documentation/Quick-Start-Guide.md)** for a 15-minute tutorial.
148+
147149
### 15-Minute Tutorial
148150

149151
Follow our [Quick Start Guide](Documentation/Quick-Start-Guide.md) to:
@@ -186,6 +188,12 @@ Aquiis is available as a portable Windows executable (.exe). No installation req
186188
- All dependencies bundled (no installation required)
187189
- Optional: SendGrid (email) and Twilio (SMS) for notifications
188190

191+
### Data & Backups
192+
193+
- SQLite database stored locally in application data folder
194+
- Regular backups recommended (manual or scheduled)
195+
- See **[Database Management Guide](Documentation/Database-Management-Guide.md)** for backup/restore procedures
196+
189197
---
190198

191199
## 📚 Documentation

0 commit comments

Comments
 (0)