Skip to content

Commit 8a905b2

Browse files
committed
docs: overview as landing page
1 parent e3b4ed0 commit 8a905b2

File tree

3 files changed

+16
-15
lines changed

3 files changed

+16
-15
lines changed

docs/overview/overview.md renamed to docs/overview.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ It applies **versioned, auditable changes** to the external systems your applica
1212
Unlike infrastructure-as-code tools, Flamingock runs **inside your application** (or via the **CLI**).
1313
It ensures these systems evolve **safely, consistently, and in sync with your code at runtime**.
1414

15-
👉 For a deeper explanation, see the [Introduction](./get-started/introduction.md)
15+
👉 For a deeper explanation, see the [Introduction](./overview/Introduction)
1616

1717
---
1818

@@ -45,9 +45,9 @@ public class _0001__AddUserStatus {
4545
}
4646
```
4747

48-
👉 **Continue to [Quick Start Guide](./quick-start)**
49-
👉 **Learn the [Core Concepts](./core-concepts)**
50-
👉 **Read the full [Introduction](./Introduction)**
48+
👉 **Continue to [Quick Start Guide](./overview/quick-start)**
49+
👉 **Learn the [Core Concepts](./overview/core-concepts)**
50+
👉 **Read the full [Introduction](./overview/Introduction)**
5151

5252
---
5353

@@ -65,21 +65,21 @@ public class _0001__AddUserStatus {
6565

6666
## 📚 Documentation Structure
6767

68-
**Get started**[Introduction](./Introduction), [Quick Start](./quick-start), [Core Concepts](./core-concepts), [Change-as-Code](./Change-as-Code)
68+
**Get started**[Introduction](./overview/Introduction), [Quick Start](./overview/quick-start), [Core Concepts](./overview/core-concepts), [Change-as-Code](./overview/Change-as-Code)
6969

70-
**Changes**[Anatomy](../changes/anatomy-and-structure), [Apply and rollback methods](../changes/apply-and-rollback-methods), [Types & implementation](../changes/types-and-implementation), [Best practices](../changes/best-practices)
70+
**Changes**[Anatomy](./changes/anatomy-and-structure), [Apply and rollback methods](./changes/apply-and-rollback-methods), [Types & implementation](./changes/types-and-implementation), [Best practices](./changes/best-practices)
7171

72-
**Target Systems** – Supported integrations ([SQL](../target-systems/sql-target-system), [MongoDB](../target-systems/mongodb-target-system), [DynamoDB](../target-systems/dynamodb-target-system), [Introduction](../target-systems/introduction), …)
72+
**Target Systems** – Supported integrations ([SQL](./target-systems/sql-target-system), [MongoDB](./target-systems/mongodb-target-system), [DynamoDB](./target-systems/dynamodb-target-system), [Introduction](./target-systems/introduction), …)
7373

74-
**Community Audit Stores**[MongoDB](../community-audit-stores/mongodb-audit-store), [DynamoDB](../community-audit-stores/dynamodb-audit-store), [SQL](../community-audit-stores/sql-audit-store)
74+
**Audit Stores**[MongoDB](./audit-stores/mongodb-audit-store), [DynamoDB](./audit-stores/dynamodb-audit-store), [SQL](./audit-stores/sql-audit-store)
7575

76-
**Safety & Recovery**[Recovery strategies](../safety-and-recovery/introduction), [Safety mechanisms](../safety-and-recovery/introduction)
76+
**Safety & Recovery**[Recovery strategies](./safety-and-recovery/introduction), [Safety mechanisms](./safety-and-recovery/introduction)
7777

78-
**Templates**[How to use](../templates/templates-how-to-use), [Introduction](../templates/templates-introduction)
78+
**Templates**[How to use](./templates/templates-how-to-use), [Introduction](./templates/templates-introduction)
7979

80-
**Supported Frameworks**[Spring Boot](../frameworks/springboot-integration/introduction), [Standalone runner](../flamingock-library-config/setup-and-stages)
80+
**Supported Frameworks**[Spring Boot](./frameworks/springboot-integration/introduction), [Standalone runner](./flamingock-library-config/setup-and-stages)
8181

82-
**Testing**[Unit testing](../testing/unit-testing), [Integration testing](../testing/integration-testing), [Spring Boot testing](../testing/springboot-integration-testing)
82+
**Testing**[Unit testing](./testing/unit-testing), [Integration testing](./testing/integration-testing), [Spring Boot testing](./testing/springboot-integration-testing)
8383

8484
**CLI** – Command-line usage and operations
8585

@@ -95,7 +95,7 @@ public class _0001__AddUserStatus {
9595

9696
**Self-Hosted Edition** – Cloud features, deployable in your infra
9797

98-
👉 **Learn more about [Cloud Edition](../cloud-edition/cloud-edition)**
98+
👉 **Learn more about [Cloud Edition](./cloud-edition/cloud-edition)**
9999

100100
---
101101

docusaurus.config.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@ const config = {
4949
/** @type {import('@docusaurus/preset-classic').Options} */
5050
({
5151
docs: {
52+
routeBasePath: '/', // Docs at the root of the site
5253
sidebarPath: './sidebars.js',
5354
sidebarCollapsible: false,
5455
// Please change this to your repo.
@@ -86,7 +87,7 @@ const config = {
8687
],
8788

8889
customFields: {
89-
homepageRedirect: '/docs/overview/Introduction',
90+
homepageRedirect: '/overview',
9091
},
9192

9293
themeConfig:

sidebars.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
const sidebars = {
1818
// Hybrid approach: grouped auto-generated sections with visual dividers
1919
tutorialSidebar: [
20-
20+
'overview', // Add explicit reference to overview.md at docs root
2121
{
2222
type: 'html',
2323
value: '<hr class="sidebar-divider" />',

0 commit comments

Comments
 (0)