Skip to content

Commit d8193c0

Browse files
committed
Refactored documentation to make it AI and human friendly.
1 parent 7cf277d commit d8193c0

161 files changed

Lines changed: 4945 additions & 7182 deletions

File tree

Some content is hidden

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

.env

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
# To customize variables locally, copy `.env.local.example` to `.env.local`,
1616
# and add your custom values there.
1717
#
18-
# @see https://www.vortextemplate.com/docs/workflows/variables
18+
# @see https://www.vortextemplate.com/docs/development/variables
1919

2020
################################################################################
2121
# GENERAL #
@@ -223,7 +223,7 @@ VORTEX_DB_DOWNLOAD_ACQUIA_DB_NAME=your_site
223223
# Versioning scheme used for releases.
224224
#
225225
# Can be one of: calver, semver, other
226-
# @see https://www.vortextemplate.com/docs/workflows/releasing
226+
# @see https://www.vortextemplate.com/docs/releasing
227227
VORTEX_RELEASE_VERSION_SCHEME=calver
228228

229229
#;< DEPLOYMENT
@@ -232,7 +232,7 @@ VORTEX_RELEASE_VERSION_SCHEME=calver
232232
################################################################################
233233

234234
# Deployment occurs when tests pass in the CI environment.
235-
# @see https://www.vortextemplate.com/docs/workflows/deployment
235+
# @see https://www.vortextemplate.com/docs/deployment
236236
VORTEX_DEPLOY_TYPES=artifact
237237
#;> DEPLOYMENT
238238

@@ -242,7 +242,7 @@ VORTEX_DEPLOY_TYPES=artifact
242242
################################################################################
243243

244244
# Notificaions are sent accross multiple channels before and after deployment.
245-
# @see https://www.vortextemplate.com/docs/workflows/notifications
245+
# @see https://www.vortextemplate.com/docs/deployment/notifications
246246

247247
# The channels of the notifications.
248248
#

.env.local.example

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
#
77
# The .env.local file is excluded via .gitignore and will not be committed.
88
#
9-
# @see https://www.vortextemplate.com/docs/workflows/variables
9+
# @see https://www.vortextemplate.com/docs/development/variables
1010

1111
# Local development URL.
1212
# Override only if you need to use a different URL than the default.

.vortex/.ahoy.yml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,9 +48,19 @@ commands:
4848
ahoy lint-docs
4949
ahoy lint-markdown
5050
51+
lint-fix:
52+
name: Fix linting issues in Vortex project.
53+
cmd: |
54+
ahoy lint-installer-fix
55+
ahoy lint-docs-fix
56+
ahoy lint-markdown-fix
57+
5158
lint-installer:
5259
cmd: composer --working-dir installer lint
5360

61+
lint-installer-fix:
62+
cmd: composer --working-dir installer lint-fix
63+
5464
lint-scripts:
5565
cmd: ./tests/lint.scripts.sh
5666

@@ -68,6 +78,9 @@ commands:
6878
yarn --cwd=docs run lint
6979
yarn --cwd=./docs run spellcheck
7080
81+
lint-docs-fix:
82+
cmd: yarn --cwd=docs run lint-fix
83+
7184
test:
7285
name: Test Vortex project.
7386
cmd: |

0 commit comments

Comments
 (0)