Skip to content

Refactored documentation to make it AI and human friendly. #2248

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AlexSkrypnyk merged 1 commit into from
Feb 8, 2026
Merged

Refactored documentation to make it AI and human friendly. #2248

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions .env
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
# To customize variables locally, copy `.env.local.example` to `.env.local`,
# and add your custom values there.
#
# @see https://www.vortextemplate.com/docs/workflows/variables
# @see https://www.vortextemplate.com/docs/development/variables

################################################################################
# GENERAL #
Expand Down Expand Up @@ -223,7 +223,7 @@ VORTEX_DB_DOWNLOAD_ACQUIA_DB_NAME=your_site
# Versioning scheme used for releases.
#
# Can be one of: calver, semver, other
# @see https://www.vortextemplate.com/docs/workflows/releasing
# @see https://www.vortextemplate.com/docs/releasing
VORTEX_RELEASE_VERSION_SCHEME=calver

#;< DEPLOYMENT
Expand All @@ -232,7 +232,7 @@ VORTEX_RELEASE_VERSION_SCHEME=calver
################################################################################

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

Expand All @@ -242,7 +242,7 @@ VORTEX_DEPLOY_TYPES=artifact
################################################################################

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

# The channels of the notifications.
#
Expand Down
2 changes: 1 addition & 1 deletion .env.local.example
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
#
# The .env.local file is excluded via .gitignore and will not be committed.
#
# @see https://www.vortextemplate.com/docs/workflows/variables
# @see https://www.vortextemplate.com/docs/development/variables

# Local development URL.
# Override only if you need to use a different URL than the default.
Expand Down
13 changes: 13 additions & 0 deletions .vortex/.ahoy.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,19 @@ commands:
ahoy lint-docs
ahoy lint-markdown

lint-fix:
name: Fix linting issues in Vortex project.
cmd: |
ahoy lint-installer-fix
ahoy lint-docs-fix
ahoy lint-markdown-fix

lint-installer:
cmd: composer --working-dir installer lint

lint-installer-fix:
cmd: composer --working-dir installer lint-fix

lint-scripts:
cmd: ./tests/lint.scripts.sh

Expand All @@ -68,6 +78,9 @@ commands:
yarn --cwd=docs run lint
yarn --cwd=./docs run spellcheck

lint-docs-fix:
cmd: yarn --cwd=docs run lint-fix

test:
name: Test Vortex project.
cmd: |
Expand Down
Loading