@@ -7,7 +7,7 @@ This page provides a high-level overview of how the template is structured, how
77its components work together, and how your project benefits from its
88architecture.
99
10- ## Design Principles
10+ ## Design principles
1111
1212** Vortex** is guided by principles that prioritize simplicity, visibility, and
1313maintainability:
@@ -21,7 +21,7 @@ maintainability:
2121- ** Explicit logging helps** : Scripts log every major step, so it’s easy to
2222 follow what’s going on.
2323
24- ## System Components
24+ ## System components
2525
2626The system is made up of several modular pieces that work together:
2727
@@ -41,7 +41,7 @@ You can see how these parts connect in the diagram below:
4141<img src = " /img/diagram-light.png#gh-light-mode-only" alt = " System components" />
4242</picture >
4343
44- ## Local Development Environment
44+ ## Local development environment
4545
4646Your project includes a containerized local environment using Docker Compose and
4747production-grade Lagoon images. This ensures consistency between local, CI, and
@@ -66,9 +66,9 @@ Because provisioning is centralized, it runs exactly in the same way in every
6666environment: local, CI, or hosting. This eliminates "works on my machine"
6767problems and makes the process predictable for everyone.
6868
69- ➡️ See [ Drupal > Provision] ( .. /drupal/provision )
69+ ➡️ See [ Drupal > Provision] ( ./drupal/provision )
7070
71- ### Module and Theme Scaffolds
71+ ### Module and theme scaffolds
7272
7373We include examples of a custom module and theme, each fully integrated with
7474tests. These show you how to:
@@ -79,10 +79,10 @@ tests. These show you how to:
7979
8080Use these scaffolds as starting points for your own work.
8181
82- ➡️ See [ Drupal > Module Scaffold] ( .. /drupal/module-scaffold )
83- and [ Drupal > Theme Scaffold] ( .. /drupal/theme-scaffold )
82+ ➡️ See [ Drupal > Module Scaffold] ( ./drupal/module-scaffold )
83+ and [ Drupal > Theme Scaffold] ( ./drupal/theme-scaffold )
8484
85- ### Settings Management
85+ ### Settings management
8686
8787** Vortex** includes a structured way to manage Drupal settings per environment.
8888Here's how it works:
@@ -95,9 +95,9 @@ Here's how it works:
9595This structure gives you clarity, avoids config sprawl, and lets you remove a
9696module’s settings cleanly when no longer needed.
9797
98- ➡️ See [ Drupal > Settings] ( .. /drupal/settings )
98+ ➡️ See [ Drupal > Settings] ( ./drupal/settings )
9999
100- ## Code Quality and Testing
100+ ## Code quality and testing
101101
102102** Vortex** ships with pre-configured tools for maintaining code quality:
103103
@@ -111,10 +111,10 @@ You’ll also find scaffolds for:
111111- ** PHPUnit** : Unit and kernel testing
112112- ** Behat** : Behavior-driven testing with screenshot capture and extra steps
113113
114- ➡️ See [ Tools > PHPStan] ( .. /tools/phpstan ) , [ Tools > PHPCS] ( . ./tools/phpcs) ,
115- [ Tools > Behat] ( .. /tools/behat ) , and [ Tools > PHPUnit] ( . ./tools/phpunit)
114+ ➡️ See [ Tools > PHPStan] ( ./tools/phpstan ) , [ Tools > PHPCS] ( ./tools/phpcs ) ,
115+ [ Tools > Behat] ( ./tools/behat ) , and [ Tools > PHPUnit] ( ./tools/phpunit )
116116
117- ## Continuous Integration Workflows
117+ ## Continuous integration workflows
118118
119119** Vortex** supports GitHub Actions and CircleCI. You choose which one to use in your
120120project. The workflows include:
@@ -128,9 +128,9 @@ project. The workflows include:
128128Each continuous integration configuration mirrors what happens locally and in hosting to ensure
129129uniformity.
130130
131- ➡️ See [ Continuous Integration] ( .. /continuous-integration )
131+ ➡️ See [ Continuous Integration] ( ./continuous-integration )
132132
133- ## Hosting Integrations
133+ ## Hosting integrations
134134
135135Out of the box, ** Vortex** supports Acquia and Lagoon hosting. These integrations:
136136
@@ -140,9 +140,9 @@ Out of the box, **Vortex** supports Acquia and Lagoon hosting. These integration
140140You can use ** Vortex** with other platforms too, but these are first-class
141141integrations.
142142
143- ➡️ See [ Hosting] ( .. /hosting )
143+ ➡️ See [ Hosting] ( ./hosting )
144144
145- ## Automated Dependency Updates
145+ ## Automated dependency updates
146146
147147** Vortex** includes configuration for RenovateBot to automate dependency upgrades:
148148
@@ -153,14 +153,25 @@ integrations.
153153You can host RenovateBot yourself or use the cloud version, and you can tweak
154154the schedule as needed.
155155
156- ➡️ See [ Tools > Renovate] ( .. /tools/renovate )
156+ ➡️ See [ Tools > Renovate] ( ./tools/renovate )
157157
158- ## Documentation & Onboarding
158+ ## Documentation & onboarding
159159
160160** Vortex** includes centralized documentation (what you’re reading now), as well as
161161a scaffold for adding project-specific docs within your own repository.
162162
163- ## Workflow Scripts
163+ ## Complete code lifecycle
164+
165+ <details >
166+ <summary >Expand to see the complete code lifecycle diagram</summary >
167+
168+ import CodeLifecycle from ' ./workflows/_code-lifecycle.mdx' ;
169+
170+ <CodeLifecycle />
171+
172+ </details >
173+
174+ ## Workflow scripts
164175
165176A workflow is a sequence of steps to achieve a goal. In ** Vortex** , those are
166177defined via POSIX-compliant Bash scripts in ` scripts/vortex ` .
@@ -180,12 +191,12 @@ During initial project setup, `.env` file is updated with project-specific
180191values like project name, email etc. Then, environment variables (secrets,
181192tokens, etc.) are set in CI or hosting environments.
182193
183- Refer to the [ Workflows] ( .. /workflows ) section for more details.
194+ Refer to the [ Workflows] ( ./workflows ) section for more details.
184195
185196### Router scripts
186197
187- Most **** Vortex** ** commands are implemented as router scripts entry points like
188- ` download-db.sh ` or ` deploy.sh—that ` dynamically invoke a more specific logic
198+ Most ** Vortex** commands are implemented as router scripts entry points like
199+ ` download-db.sh ` or ` deploy.sh ` that dynamically invoke a more specific logic
189200for your setup, based on configuration or environment variables.
190201
191202For example:
@@ -207,4 +218,4 @@ For example:
207218
208219</details >
209220
210- ➡️ See [ Workflows] ( .. /workflows )
221+ ➡️ See [ Workflows] ( ./workflows )
0 commit comments