Skip to content

Commit 4aa9ee5

Browse files
committed
Updated documentation structure and fixed typos.
1 parent cf775c7 commit 4aa9ee5

48 files changed

Lines changed: 430 additions & 365 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.vortex/CLAUDE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -804,6 +804,7 @@ Each system:
804804
- Run spellcheck before committing content changes
805805
- Test interactive components in both development and production builds
806806
- Maintain consistent terminology across all documentation
807+
- **Use sentence case for all headings** - only the first letter is capitalized, except for proper nouns (Vortex, GitHub, Drupal, Docker Compose, CircleCI, etc.) and acronyms (CI/CD, SSH, API, BDD, PHPUnit, etc.)
807808
808809
### 2. Installer System (.vortex/installer/)
809810

.vortex/docs/content/README.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@ platforms. Everything is pre-configured and ready to use, so teams can focus on
2424
building features instead of setting up infrastructure.
2525

2626
By standardizing project structure and tooling, **Vortex** ensures a consistent
27-
developer experience across every project that uses it. Whether youre starting
28-
fresh or joining an existing Vortex-based site, you can get up to speed quickly
27+
developer experience across every project that uses it. Whether you're starting
28+
fresh or joining an existing **Vortex**-based site, you can get up to speed quickly
2929
and start contributing right away.
3030

3131
The template is actively maintained and kept in sync with the latest tools.
@@ -45,25 +45,25 @@ projects over time.
4545
<li>📖 Project documentation</li>
4646
</ul>
4747

48-
Refer to [Features](getting-started/features.mdx) and [Architecture](getting-started/architecture.mdx) for more details.
48+
Refer to [Features](features) and [Architecture](architecture) for more details.
4949

5050
## 🚀 Quick start
5151

5252
```bash
5353
curl -SsL https://www.vortextemplate.com/install > installer.php && php installer.php
5454
```
5555

56-
Refer to [Installation](getting-started/installation.mdx) for more details.
56+
Refer to [Installation](installation) for more details.
5757

58-
## 🛟 Getting Help
58+
## 🛟 Getting help
5959

60-
Refer to [Support](../support) for more details on how to get help with Vortex.
60+
Refer to [Support](support) for more details on how to get help with **Vortex**.
6161

6262
## 🤝 Contributing
6363

6464
Refer to [Contributing](contributing) for more details.
6565

6666
## ⚖️ License
6767

68-
Vortex is licensed under the [GPL-3.0](https://www.gnu.org/licenses/gpl-3.0.en.html) license. See
68+
**Vortex** is licensed under the [GPL-3.0](https://www.gnu.org/licenses/gpl-3.0.en.html) license. See
6969
the [LICENSE](https://github.com/drevops/vortex/blob/develop/LICENSE) file for more details.

.vortex/docs/content/getting-started/architecture.mdx renamed to .vortex/docs/content/architecture.mdx

Lines changed: 35 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ This page provides a high-level overview of how the template is structured, how
77
its components work together, and how your project benefits from its
88
architecture.
99

10-
## Design Principles
10+
## Design principles
1111

1212
**Vortex** is guided by principles that prioritize simplicity, visibility, and
1313
maintainability:
@@ -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

2626
The 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

4646
Your project includes a containerized local environment using Docker Compose and
4747
production-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
6666
environment: local, CI, or hosting. This eliminates "works on my machine"
6767
problems 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

7373
We include examples of a custom module and theme, each fully integrated with
7474
tests. These show you how to:
@@ -79,10 +79,10 @@ tests. These show you how to:
7979

8080
Use 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.
8888
Here's how it works:
@@ -95,9 +95,9 @@ Here's how it works:
9595
This structure gives you clarity, avoids config sprawl, and lets you remove a
9696
module’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
120120
project. The workflows include:
@@ -128,9 +128,9 @@ project. The workflows include:
128128
Each continuous integration configuration mirrors what happens locally and in hosting to ensure
129129
uniformity.
130130

131-
➡️ See [Continuous Integration](../continuous-integration)
131+
➡️ See [Continuous Integration](./continuous-integration)
132132

133-
## Hosting Integrations
133+
## Hosting integrations
134134

135135
Out 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
140140
You can use **Vortex** with other platforms too, but these are first-class
141141
integrations.
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.
153153
You can host RenovateBot yourself or use the cloud version, and you can tweak
154154
the 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
161161
a 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

165176
A workflow is a sequence of steps to achieve a goal. In **Vortex**, those are
166177
defined via POSIX-compliant Bash scripts in `scripts/vortex`.
@@ -180,12 +191,12 @@ During initial project setup, `.env` file is updated with project-specific
180191
values like project name, email etc. Then, environment variables (secrets,
181192
tokens, 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
189200
for your setup, based on configuration or environment variables.
190201

191202
For example:
@@ -207,4 +218,4 @@ For example:
207218

208219
</details>
209220

210-
➡️ See [Workflows](../workflows)
221+
➡️ See [Workflows](./workflows)

.vortex/docs/content/continuous-integration/README.mdx

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ sidebar_position: 1
55

66
# Continuous Integration
77

8-
**Vortex** offers continuous integration configurations for GitHub Actions and
9-
CircleCI providers that allows to automate the process of building, testing, and
10-
deploying your site.
8+
**Vortex** offers continuous integration configurations for [GitHub Actions](/docs/continuous-integration/github-actions)
9+
and [CircleCI](/docs/continuous-integration/circleci) providers that allow you to
10+
automate the process of building, testing, and deploying your site.
1111

1212
The workflow configuration is identical for both continuous integration
1313
providers. You would need to choose one of them and follow the setup
@@ -16,7 +16,7 @@ instructions.
1616
The continuous integration pipeline consists of multiple jobs executed in a
1717
containerized environment to ensure consistency across runs.
1818

19-
## Trigger Conditions
19+
## Trigger conditions
2020

2121
The continuous integration pipeline is triggered by:
2222

@@ -31,7 +31,16 @@ The continuous integration pipeline is triggered by:
3131
- **Pull requests** to these branches
3232
- **Scheduled runs** for automatic database caching
3333

34-
## Workflow Structure
34+
## Workflow structure
35+
36+
<details>
37+
<summary>Expand to see the complete code lifecycle diagram</summary>
38+
39+
import CodeLifecycle from '../workflows/_code-lifecycle.mdx';
40+
41+
<CodeLifecycle />
42+
43+
</details>
3544

3645
### 1. Database
3746

@@ -43,6 +52,8 @@ The continuous integration pipeline is triggered by:
4352

4453
- Runs after the `database` job
4554
- Uses Docker Compose to set up the environment
55+
- Validates Composer lock and audits dependencies
56+
- Assembles the codebase by installing dependencies
4657
- Provisions a website
4758
- Lints code (only on the first instance)
4859
- Runs unit tests
@@ -57,7 +68,7 @@ The continuous integration pipeline is triggered by:
5768
- Adds required secrets and environment variables
5869
- Triggers a deployment using a router script
5970

60-
## Caching Strategy
71+
## Caching strategy
6172

6273
Database is downloaded overnight and cached so that the next continuous integration run on the same
6374
day uses the cached database dump.
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# CircleCI
2+
3+
:::note Content coming soon
4+
5+
This section will provide detailed information about using **Vortex** with
6+
the [CircleCI](https://circleci.com/) continuous integration platform.
7+
8+
:::
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# GitHub Actions
2+
3+
:::note Content coming soon
4+
5+
This section will provide detailed information about using **Vortex** with
6+
the [GitHub Actions](https://github.com/features/actions) continuous integration platform.
7+
8+
:::

.vortex/docs/content/contributing/maintenance/documentation.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ cd .vortex/docs
2121
ahoy build
2222
```
2323

24-
Parts of the documentation is generated automatically from the codebase.
24+
Parts of the documentation are generated automatically from the codebase.
2525
To update it, run:
2626

2727
```bash

.vortex/docs/content/contributing/maintenance/release.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Release
22

3-
Follow the steps below to release a new version of the Vortex:
3+
Follow the steps below to release a new version of **Vortex**:
44

55
1. Run renovate bot locally to update all dependencies outside of the schedule:
66
```
@@ -13,6 +13,6 @@ renovate --schedule= --force-cli=true drevops/vortex
1313
6. Increment minor version of all packages in `composer.json`. Run `composer update -W && composer bump`.
1414
7. Update minor version of dependencies in theme's `package.json`.
1515
8. Increment the cache version in `.circleci/config.yml` and `.github/workflows/build-test-deploy.yml`.
16-
9. Updated documentation with `cd .vortex && ahoy update-docs`.
16+
9. Update documentation with `cd .vortex && ahoy update-docs`.
1717
10. Update installer video with `cd .vortex && ahoy update-installer-video`.
1818
11. Create new release notes using [release template](./release_template.md).

0 commit comments

Comments
 (0)