-
-
Notifications
You must be signed in to change notification settings - Fork 28
Added support for all AI agents + docs. #2272
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.
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
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| --- | ||
| sidebar_label: AI | ||
| sidebar_position: 7 | ||
| --- | ||
|
|
||
| # AI | ||
|
|
||
| **Vortex** provides built-in support for AI coding agents. The integration is | ||
| configured through structured markdown files that give agents the context they | ||
| need to work effectively within the project. | ||
|
|
||
| ## How it works | ||
|
|
||
| The AI integration follows the same two-tier documentation pattern used | ||
| throughout **Vortex**: | ||
|
|
||
| - **What** applies to the project is defined in the `docs/` directory. The | ||
| agent reads all files in `docs/` to understand project-specific decisions | ||
| such as testing conventions, CI configuration, deployment rules, and | ||
| release processes. | ||
| - **How** to perform operations is sourced from the | ||
| https://www.vortextemplate.com/docs (this site). The | ||
| `AGENTS.md` file instructs agents to fetch operational guides from the | ||
| website and cache them locally in `.data/ai-artifacts/`. | ||
|
|
||
| This means AI agents receive the same layered guidance as human developers: | ||
| project-level decisions first, then Vortex-level procedures. | ||
|
|
||
| ## Configuration files | ||
|
|
||
| ### `AGENTS.md` | ||
|
|
||
| The [`AGENTS.md`](https://github.com/drevops/vortex/blob/main/AGENTS.md) file | ||
| in the project root is the primary configuration for AI coding agents. It is | ||
| an agent-agnostic file that any AI tool can use. | ||
|
|
||
| Key sections include: | ||
|
|
||
| - **Daily development tasks** — a reference of `ahoy` commands for building, | ||
| testing, and managing the local environment. | ||
| - **Critical rules** — constraints that agents must always follow (e.g., never | ||
| modify `scripts/vortex/`, always export config after admin UI changes). | ||
| - **Key directories** — the project's directory layout. | ||
| - **Documentation** — instructions for agents to check `docs/` files for | ||
| project-specific decisions and to fetch operational documentation from | ||
| https://www.vortextemplate.com/docs. Fetched documentation is cached locally so | ||
| that agents can reuse it across sessions without repeated requests. | ||
|
|
||
| ### `CLAUDE.md` | ||
|
|
||
| The [`CLAUDE.md`](https://github.com/drevops/vortex/blob/main/CLAUDE.md) file | ||
| is automatically loaded by Claude Code at the start of every session. It | ||
| references `AGENTS.md` for the full development guide. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
85 changes: 85 additions & 0 deletions
85
.vortex/installer/tests/Fixtures/handler_process/_baseline/AGENTS.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,85 @@ | ||
| # star wars - Development Guide | ||
|
|
||
| ## Daily Development Tasks | ||
|
|
||
| ```bash | ||
| # Environment | ||
| ahoy up # Start containers | ||
| ahoy down # Stop containers | ||
| ahoy info # Show URLs and status | ||
| ahoy login # Get admin login URL | ||
|
|
||
| # Build & Database | ||
| ahoy download-db # Download fresh database from remote | ||
| ahoy build # Complete site rebuild | ||
| ahoy provision # Re-provision (import DB + apply config) | ||
| ahoy import-db # Import database from file without applying config | ||
| ahoy export-db # Export current local database | ||
|
|
||
| # Drush commands | ||
| ahoy drush cr # Clear cache | ||
| ahoy drush updb # Run database updates | ||
| ahoy drush cex # Export configuration to code | ||
| ahoy drush cim # Import configuration from code | ||
| ahoy drush uli # Get one-time login link | ||
| ahoy drush status # Check site status | ||
|
|
||
| # Composer | ||
| ahoy composer install | ||
| ahoy composer require drupal/[module_name] | ||
|
|
||
| # Code quality | ||
| ahoy lint # Check code style | ||
| ahoy lint-fix # Auto-fix code style | ||
|
|
||
| # PHPUnit testing | ||
| ahoy test # Run PHPUnit tests | ||
| ahoy test-unit # Run PHPUnit Unit tests | ||
| ahoy test-kernel # Run PHPUnit Kernel tests | ||
| ahoy test-functional # Run PHPUnit Functional tests | ||
| ahoy test -- --filter=TestClassName # Run specific PHPUnit test class | ||
|
|
||
| # Behat testing | ||
| ahoy test-bdd # Run Behat tests | ||
| ahoy test-bdd -- --tags=@tagname # Run Behat tests with specific tag | ||
| ``` | ||
|
|
||
| ## Critical Rules | ||
|
|
||
| - **Never modify** `scripts/vortex/` - use `scripts/custom/` for your scripts | ||
| - **Never use** `ahoy drush php:eval` - use `ahoy drush php:script` instead | ||
| - **Always export config** after admin UI changes: `ahoy drush cex` | ||
|
|
||
| ## Key Directories | ||
|
|
||
| - `web/modules/custom/` - Custom modules | ||
| - `web/themes/custom/` - Custom themes | ||
| - `config/default/` - Drupal configuration | ||
| - `scripts/custom/` - Project scripts | ||
| - `patches/` - Module patches | ||
|
|
||
| ## Documentation | ||
|
|
||
| This project uses two documentation sources: | ||
|
|
||
| ### Project-specific documentation (`docs/`) | ||
|
|
||
| The `docs/` directory contains **what** applies to this project: | ||
|
|
||
| - `docs/testing.md` - Testing conventions and agreements | ||
| - `docs/ci.md` - CI provider and configuration | ||
| - `docs/deployment.md` - Hosting provider and deployment rules | ||
| - `docs/releasing.md` - Version scheme and release process | ||
| - `docs/faqs.md` - Project-specific FAQs | ||
|
|
||
| **Always check these files first** to understand project-specific decisions. | ||
|
|
||
| ### Vortex documentation (vortextemplate.com) | ||
|
|
||
| For **how** to perform operations, fetch from https://www.vortextemplate.com/docs. | ||
|
|
||
| Use the sitemap to discover available pages: https://www.vortextemplate.com/sitemap.xml | ||
|
|
||
| **Caching:** Save fetched docs to `.data/ai-artifacts/docs-[topic].md` with header | ||
| `<!-- Source: [URL] | Cached: [YYYY-MM-DD] -->`. | ||
| Re-fetch if user reports docs are outdated. |
92 changes: 2 additions & 90 deletions
92
.vortex/installer/tests/Fixtures/handler_process/_baseline/CLAUDE.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,91 +1,3 @@ | ||
| # star wars - Development Guide | ||
| # AI Agent Configuration | ||
|
|
||
| <!-- CLAUDE_CONTEXT | ||
| Drupal project built with Vortex template. Uses Docker locally, ahoy commands. | ||
| For detailed guides, fetch from https://www.vortextemplate.com and cache in .claude/artifacts/. | ||
| --> | ||
|
|
||
| ## Daily Development Tasks | ||
|
|
||
| ```bash | ||
| # Environment | ||
| ahoy up # Start containers | ||
| ahoy down # Stop containers | ||
| ahoy info # Show URLs and status | ||
| ahoy login # Get admin login URL | ||
|
|
||
| # Build & Database | ||
| ahoy download-db # Download fresh database from remote | ||
| ahoy build # Complete site rebuild | ||
| ahoy provision # Re-provision (import DB + apply config) | ||
| ahoy import-db # Import database from file without applying config | ||
| ahoy export-db # Export current local database | ||
|
|
||
| # Drush commands | ||
| ahoy drush cr # Clear cache | ||
| ahoy drush updb # Run database updates | ||
| ahoy drush cex # Export configuration to code | ||
| ahoy drush cim # Import configuration from code | ||
| ahoy drush uli # Get one-time login link | ||
| ahoy drush status # Check site status | ||
|
|
||
| # Composer | ||
| ahoy composer install | ||
| ahoy composer require drupal/[module_name] | ||
|
|
||
| # Code quality | ||
| ahoy lint # Check code style | ||
| ahoy lint-fix # Auto-fix code style | ||
|
|
||
| # PHPUnit testing | ||
| ahoy test # Run PHPUnit tests | ||
| ahoy test-unit # Run PHPUnit Unit tests | ||
| ahoy test-kernel # Run PHPUnit Kernel tests | ||
| ahoy test-functional # Run PHPUnit Functional tests | ||
| ahoy test -- --filter=TestClassName # Run specific PHPUnit test class | ||
|
|
||
| # Behat testing | ||
| ahoy test-bdd # Run Behat tests | ||
| ahoy test-bdd -- --tags=@tagname # Run Behat tests with specific tag | ||
| ``` | ||
|
|
||
| ## Critical Rules | ||
|
|
||
| - **Never modify** `scripts/vortex/` - use `scripts/custom/` for your scripts | ||
| - **Never use** `ahoy drush php:eval` - use `ahoy drush php:script` instead | ||
| - **Always export config** after admin UI changes: `ahoy drush cex` | ||
|
|
||
| ## Key Directories | ||
|
|
||
| - `web/modules/custom/` - Custom modules | ||
| - `web/themes/custom/` - Custom themes | ||
| - `config/default/` - Drupal configuration | ||
| - `scripts/custom/` - Project scripts | ||
| - `patches/` - Module patches | ||
|
|
||
| ## Documentation | ||
|
|
||
| This project uses two documentation sources: | ||
|
|
||
| ### Project-specific documentation (`docs/`) | ||
|
|
||
| The `docs/` directory contains **what** applies to this project: | ||
|
|
||
| - `docs/testing.md` - Testing conventions and agreements | ||
| - `docs/ci.md` - CI provider and configuration | ||
| - `docs/deployment.md` - Hosting provider and deployment rules | ||
| - `docs/releasing.md` - Version scheme and release process | ||
| - `docs/faqs.md` - Project-specific FAQs | ||
|
|
||
| **Always check these files first** to understand project-specific decisions. | ||
|
|
||
| ### Vortex documentation (vortextemplate.com) | ||
|
|
||
| For **how** to perform operations, fetch from https://www.vortextemplate.com. | ||
|
|
||
| Use the sitemap to discover available pages: | ||
| https://www.vortextemplate.com/sitemap.xml | ||
|
|
||
| **Caching:** Save fetched docs to `.claude/artifacts/docs-[topic].md` with header | ||
| `<!-- Source: [URL] | Cached: [YYYY-MM-DD] -->`. | ||
| Re-fetch if user reports docs are outdated. | ||
| @AGENTS.md |
File renamed without changes.
Empty file.
File renamed without changes.
2 changes: 1 addition & 1 deletion
2
.../handler_process/hosting_acquia/CLAUDE.md → .../handler_process/hosting_acquia/AGENTS.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| @@ -57,8 +57,8 @@ | ||
| @@ -52,8 +52,8 @@ | ||
|
|
||
| ## Key Directories | ||
|
|
||
|
|
||
2 changes: 1 addition & 1 deletion
2
...s/hosting_project_name___acquia/CLAUDE.md → ...s/hosting_project_name___acquia/AGENTS.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| @@ -57,8 +57,8 @@ | ||
| @@ -52,8 +52,8 @@ | ||
|
|
||
| ## Key Directories | ||
|
|
||
|
|
||
6 changes: 6 additions & 0 deletions
6
.vortex/installer/tests/Fixtures/handler_process/names/AGENTS.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| @@ -1,4 +1,4 @@ | ||
| -# star wars - Development Guide | ||
| +# New hope - Development Guide | ||
|
|
||
| ## Daily Development Tasks | ||
|
|
6 changes: 0 additions & 6 deletions
6
.vortex/installer/tests/Fixtures/handler_process/names/CLAUDE.md
This file was deleted.
Oops, something went wrong.
2 changes: 1 addition & 1 deletion
2
...ures/handler_process/tools_none/CLAUDE.md → ...rocess/tools_groups_no_be_tests/AGENTS.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| @@ -37,16 +37,6 @@ | ||
| @@ -32,16 +32,6 @@ | ||
| ahoy lint # Check code style | ||
| ahoy lint-fix # Auto-fix code style | ||
|
|
||
|
|
||
2 changes: 1 addition & 1 deletion
2
...ols_groups_no_be_tests_circleci/CLAUDE.md → ...ols_groups_no_be_tests_circleci/AGENTS.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| @@ -37,16 +37,6 @@ | ||
| @@ -32,16 +32,6 @@ | ||
| ahoy lint # Check code style | ||
| ahoy lint-fix # Auto-fix code style | ||
|
|
||
|
|
||
2 changes: 1 addition & 1 deletion
2
.../handler_process/tools_no_behat/CLAUDE.md → .../handler_process/tools_no_behat/AGENTS.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
...process/tools_no_behat_circleci/CLAUDE.md → ...process/tools_no_behat_circleci/AGENTS.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
...andler_process/tools_no_phpunit/CLAUDE.md → ...andler_process/tools_no_phpunit/AGENTS.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| @@ -37,13 +37,6 @@ | ||
| @@ -32,13 +32,6 @@ | ||
| ahoy lint # Check code style | ||
| ahoy lint-fix # Auto-fix code style | ||
|
|
||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Handle legacy string values before calling
getResponseAsBool().Line 47 will throw if a user still has legacy env/config values like
"claude"or"none"set, which breaks non‑interactive installs. Add a compatibility path to coerce legacy strings to booleans before proceeding.🩹 Suggested backward‑compatibility fix
📝 Committable suggestion
🤖 Prompt for AI Agents