Added flows and deployment guides along with fixes for broken links #2177
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
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
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
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,49 @@ | ||
| --- | ||
| title: Community | ||
| sidebar_position: 1 | ||
| description: Join the Thunder community — get help, share ideas, report bugs, and contribute to the project. | ||
| hide_table_of_contents: true | ||
| --- | ||
|
|
||
| import Link from '@docusaurus/Link'; | ||
|
|
||
| # Community | ||
|
|
||
| Thunder is an open-source project and welcomes contributions from everyone. Whether you want to report a bug, propose a feature, improve documentation, or contribute code — you're in the right place. | ||
|
|
||
| ## Get Involved | ||
|
|
||
| <div style={{display: 'grid', gridTemplateColumns: 'repeat(auto-fit, minmax(280px, 1fr))', gap: '1.5rem', marginTop: '2rem', marginBottom: '2rem'}}> | ||
| <div style={{border: '1px solid var(--ifm-color-emphasis-300)', borderRadius: '8px', padding: '1.5rem'}}> | ||
| <h3>💬 Discussions</h3> | ||
| <p>Ask questions, share ideas, and connect with other Thunder users and contributors.</p> | ||
| <Link href="https://github.com/asgardeo/thunder/discussions">Join Discussions →</Link> | ||
| </div> | ||
| <div style={{border: '1px solid var(--ifm-color-emphasis-300)', borderRadius: '8px', padding: '1.5rem'}}> | ||
| <h3>🐛 Issues</h3> | ||
| <p>Found a bug? Report it on GitHub so the team can track and fix it.</p> | ||
| <Link href="https://github.com/asgardeo/thunder/issues">Report an Issue →</Link> | ||
| </div> | ||
| <div style={{border: '1px solid var(--ifm-color-emphasis-300)', borderRadius: '8px', padding: '1.5rem'}}> | ||
| <h3>🤝 Contributing</h3> | ||
| <p>Learn how to contribute code, documentation, or ideas to the Thunder project.</p> | ||
| <Link href="/docs/next/community/contributing/overview">Contributing Guide →</Link> | ||
| </div> | ||
| </div> | ||
|
|
||
| ## Contributing | ||
|
|
||
| The [Contributing Guide](/docs/next/community/contributing/overview) covers everything you need to know: | ||
|
|
||
| - [Reporting bugs](/docs/next/community/contributing/overview#-reporting-bugs) | ||
| - [Sharing ideas and feature requests](/docs/next/community/contributing/sharing-ideas) | ||
| - [Proposing features](/docs/next/community/contributing/proposing-features) | ||
| - [Contributing code](/docs/next/community/contributing/contributing-code/development-pipeline) | ||
|
|
||
| ## Code of Conduct | ||
|
|
||
| Thunder follows the [Contributor Covenant Code of Conduct](https://github.com/asgardeo/thunder/blob/main/CONTRIBUTING.md). By participating, you are expected to uphold this code. | ||
|
There was a problem hiding this comment. 🧩 Analysis chain🏁 Script executed: #!/bin/bash
# Check if CODE_OF_CONDUCT.md exists and what CONTRIBUTING.md contains
echo "=== Checking for CODE_OF_CONDUCT.md ==="
fd -t f "CODE_OF_CONDUCT.md"
echo -e "\n=== Checking CONTRIBUTING.md for Code of Conduct reference ==="
if [ -f "CONTRIBUTING.md" ]; then
head -50 CONTRIBUTING.md | grep -i "code of conduct" || echo "No 'code of conduct' mention in first 50 lines"
fiRepository: asgardeo/thunder Length of output: 210 🏁 Script executed: #!/bin/bash
# Check full CONTRIBUTING.md for Code of Conduct content
echo "=== Full CONTRIBUTING.md content ==="
if [ -f "CONTRIBUTING.md" ]; then
wc -l CONTRIBUTING.md
cat -n CONTRIBUTING.md | grep -i "covenant\|code of conduct" || echo "No Code of Conduct match found"
echo -e "\n=== Last 50 lines of CONTRIBUTING.md ==="
tail -50 CONTRIBUTING.md
else
echo "CONTRIBUTING.md not found"
fi
# Search entire repo for Contributor Covenant or Code of Conduct
echo -e "\n=== Searching for 'Contributor Covenant' in repo ==="
rg -i "contributor covenant" --type md --type mdx
echo -e "\n=== Searching for 'code of conduct' in repo ==="
rg -i "code of conduct" --type md --type mdxRepository: asgardeo/thunder Length of output: 535 🏁 Script executed: #!/bin/bash
# View the specific file around line 45
echo "=== docs/content/community/overview.mdx around line 45 ==="
if [ -f "docs/content/community/overview.mdx" ]; then
sed -n '40,50p' docs/content/community/overview.mdx
else
echo "File not found, searching for overview files:"
fd -t f "overview.mdx"
fiRepository: asgardeo/thunder Length of output: 611 Fix incorrect Code of Conduct link. The text references the "Contributor Covenant Code of Conduct" but links to 🤖 Prompt for AI Agents |
||
|
|
||
| ## License | ||
|
|
||
| Thunder is licensed under the [Apache License 2.0](https://github.com/asgardeo/thunder/blob/main/LICENSE). | ||
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,7 +1,136 @@ | ||
| --- | ||
| title: Docker | ||
| sidebar_position: 1 | ||
| persona: iam | ||
| description: Deploy Thunder using Docker or Docker Compose, from a quick single-container run to a production setup with an external PostgreSQL database. | ||
| --- | ||
|
|
||
| # Deploy Thunder with Docker | ||
|
|
||
| This guide walks you through deploying Thunder using Docker. You can run Thunder as a single container for development or pair it with an external PostgreSQL database for production use. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| Before you begin, ensure the following tools are installed: | ||
|
|
||
| | Tool | Minimum Version | Installation Guide | Version Check | | ||
| |------|----------------|--------------------|---------------| | ||
| | Docker | 20.10 | [Install Docker](https://docs.docker.com/engine/install/) | `docker --version` | | ||
| | Docker Compose | 2.0 | [Install Docker Compose](https://docs.docker.com/compose/install/) | `docker compose version` | | ||
|
|
||
| Verify your installation: | ||
|
|
||
| ```bash | ||
| docker --version | ||
| docker compose version | ||
| docker run hello-world | ||
| ``` | ||
|
|
||
| Thunder listens on port `8090` by default. Ensure that port is available on your host. | ||
|
|
||
| ## Run Thunder with Docker | ||
|
|
||
| ### Step 1: Pull the Image | ||
|
|
||
| ```bash | ||
| docker pull ghcr.io/asgardeo/thunder:latest | ||
| ``` | ||
|
|
||
| ### Step 2: Set Up the Server | ||
|
|
||
| Run the one-time setup script before starting Thunder for the first time. The setup initializes the configuration and database: | ||
|
|
||
| ```bash | ||
| docker run -it --rm \ | ||
| ghcr.io/asgardeo/thunder:latest \ | ||
| ./setup.sh | ||
| ``` | ||
|
|
||
| The container exits after setup completes. If you are using SQLite as the database, mount a volume to persist the database file so the setup data is available when you start the server. | ||
|
|
||
| ### Step 3: Start the Server | ||
|
|
||
| ```bash | ||
| docker run --rm \ | ||
| -p 8090:8090 \ | ||
| ghcr.io/asgardeo/thunder:latest | ||
| ``` | ||
|
Comment on lines
+41
to
+57
There was a problem hiding this comment. 🧩 Analysis chain🏁 Script executed: # First, let's understand the repository structure
find . -type f -name "Dockerfile*" -o -name "setup.sh" | head -20Repository: asgardeo/thunder Length of output: 83 🏁 Script executed: # Look for any configuration or entrypoint files
fd -t f "setup\|docker\|config" -e sh -e yaml -e yml | grep -E "(setup|docker|config)" | head -20Repository: asgardeo/thunder Length of output: 42 🏁 Script executed: # Check the documentation file in question
cat docs/content/guides/deployment-patterns/docker.mdxRepository: asgardeo/thunder Length of output: 3941 🏁 Script executed: cat -n DockerfileRepository: asgardeo/thunder Length of output: 5102 🏁 Script executed: cat -n setup.shRepository: asgardeo/thunder Length of output: 19102 🏁 Script executed: # Check if there are any volume or workdir specifications in Dockerfile
grep -n "VOLUME\|WORKDIR\|ENV.*PATH\|/opt/thunder" DockerfileRepository: asgardeo/thunder Length of output: 195 🏁 Script executed: # Check for any references to database paths or repository in the actual code
rg "repository\|database\|sqlite" --type go -A 2 -B 2 | head -50Repository: asgardeo/thunder Length of output: 42 🏁 Script executed: # Look for any environment variable or configuration related to data storage
grep -r "THUNDER_HOME\|DATABASE\|REPOSITORY" . --include="*.yaml" --include="*.yml" --include="*.go" 2>/dev/null | head -20Repository: asgardeo/thunder Length of output: 1551 🏁 Script executed: # Check the deployment.yaml to understand the data storage paths
find . -name "deployment.yaml" -exec cat {} \;Repository: asgardeo/thunder Length of output: 8605 🏁 Script executed: # Check if setup.sh and start.sh are different scripts
diff setup.sh start.shRepository: asgardeo/thunder Length of output: 17618 🏁 Script executed: # Look for any volume declarations in Dockerfile or docker-compose examples
grep -r "volume" . --include="Dockerfile*" --include="docker-compose*" --include="*.yml" --include="*.yaml" 2>/dev/null | grep -i thunderRepository: asgardeo/thunder Length of output: 726 🏁 Script executed: # Check if there's a docker-compose file that might show the intended pattern
find . -name "docker-compose*" -type f | head -5Repository: asgardeo/thunder Length of output: 147 🏁 Script executed: cat ./install/local-development/docker-compose.ymlRepository: asgardeo/thunder Length of output: 756 🏁 Script executed: cat ./install/quick-start/docker-compose.ymlRepository: asgardeo/thunder Length of output: 1554 Add volume mounts to persist setup data between containers The setup and server commands run in separate containers. Without mounting the same volume, setup data (databases and configuration) created by Mount Corrected commands+docker volume create thunder-data
+
docker run -it --rm \
+ -v thunder-data:/opt/thunder/repository \
ghcr.io/asgardeo/thunder:latest \
./setup.sh
docker run --rm \
-p 8090:8090 \
+ -v thunder-data:/opt/thunder/repository \
ghcr.io/asgardeo/thunder:latest🤖 Prompt for AI Agents |
||
|
|
||
| Thunder is now running at `https://localhost:8090`. | ||
|
|
||
| ### Customize the Configuration | ||
|
|
||
| To override the default server configuration, mount a custom `deployment.yaml` file. Create a `deployment.yaml` based on the [default configuration](https://github.com/asgardeo/thunder/blob/main/backend/cmd/server/repository/conf/deployment.yaml) and pass it to the container: | ||
|
|
||
| ```bash | ||
| docker run --rm \ | ||
| -p 8090:8090 \ | ||
| -v $(pwd)/deployment.yaml:/opt/thunder/repository/conf/deployment.yaml \ | ||
| ghcr.io/asgardeo/thunder:latest | ||
| ``` | ||
|
|
||
| To also use custom TLS certificates, mount them alongside the configuration: | ||
|
|
||
| ```bash | ||
| docker run --rm \ | ||
| -p 8090:8090 \ | ||
| -v $(pwd)/deployment.yaml:/opt/thunder/repository/conf/deployment.yaml \ | ||
| -v $(pwd)/certs/server.cert:/opt/thunder/repository/resources/security/server.cert \ | ||
| -v $(pwd)/certs/server.key:/opt/thunder/repository/resources/security/server.key \ | ||
| ghcr.io/asgardeo/thunder:latest | ||
| ``` | ||
|
|
||
| ## Access Thunder | ||
|
|
||
| Once the container is running, access Thunder at the following endpoints: | ||
|
|
||
| | Endpoint | URL | | ||
| |----------|-----| | ||
| | Application | `https://localhost:8090` | | ||
| | Sign-in / Register | `https://localhost:8090/signin` | | ||
| | Thunder Console | `https://localhost:8090/console` | | ||
|
|
||
| ## Database Setup | ||
|
|
||
| ### Embedded SQLite (Default) | ||
|
|
||
| Thunder uses SQLite by default. No additional setup is required for development or local testing. | ||
|
|
||
| ### External PostgreSQL | ||
|
|
||
| For production deployments, use an external PostgreSQL database. Thunder ships with a Docker Compose file for running a local PostgreSQL instance. | ||
|
|
||
| 1. Navigate to the `install/local-development` directory: | ||
|
|
||
| ```bash | ||
| cd install/local-development | ||
| ``` | ||
|
|
||
| 2. Start PostgreSQL in the background: | ||
|
|
||
| ```bash | ||
| docker compose up -d | ||
| ``` | ||
|
|
||
| 3. View PostgreSQL logs: | ||
|
|
||
| ```bash | ||
| docker compose logs -f | ||
| ``` | ||
|
|
||
| 4. Stop PostgreSQL: | ||
|
|
||
| ```bash | ||
| docker compose down | ||
| ``` | ||
|
|
||
| To stop PostgreSQL and delete all data: | ||
|
|
||
| ```bash | ||
| docker compose down -v | ||
| ``` | ||
|
Comment on lines
+101
to
+131
There was a problem hiding this comment. 🧩 Analysis chain🏁 Script executed: # First, let's understand the repository structure and find relevant deployment files
fd -t f "docker-compose|deployment" --max-one-result install/local-developmentRepository: asgardeo/thunder Length of output: 293 🏁 Script executed: # Let's explore the install/local-development directory structure
ls -la install/local-development/Repository: asgardeo/thunder Length of output: 297 🏁 Script executed: # Check if there's a Docker compose file and what it contains
cat install/local-development/docker-compose.yml 2>/dev/null || cat install/local-development/docker-compose.yaml 2>/dev/null || ls -la install/local-development/Repository: asgardeo/thunder Length of output: 756 🏁 Script executed: # Find where deployment.yaml is referenced or located
fd -t f "deployment\." --type f | head -20Repository: asgardeo/thunder Length of output: 531 🏁 Script executed: # Search for default database configuration in Thunder
rg -i "default.*database|database.*sqlite|database.*postgres" -A 3 -B 3 --type yaml --type json | head -50Repository: asgardeo/thunder Length of output: 3812 🏁 Script executed: # Check the default deployment.yaml configuration in the main server code
cat backend/cmd/server/repository/conf/deployment.yamlRepository: asgardeo/thunder Length of output: 1324 🏁 Script executed: # Search for database configuration environment variables or defaults
rg -i "database.*type|db.*type|sqlite|postgres" backend/cmd/server/repository/conf/ -A 2 -B 2Repository: asgardeo/thunder Length of output: 1287 🏁 Script executed: # Look at the Dockerfile to see if there's any default configuration
fd -t f "Dockerfile*" install/ | head -5Repository: asgardeo/thunder Length of output: 42 🏁 Script executed: # Check if there are any Docker-specific startup scripts or configuration
rg -i "deployment\.yaml" docs/ --type mdx | head -20Repository: asgardeo/thunder Length of output: 87 🏁 Script executed: # Look at the documentation file being reviewed to understand context
cat docs/content/guides/deployment-patterns/docker.mdx | head -150Repository: asgardeo/thunder Length of output: 3941 🏁 Script executed: # Search for PostgreSQL configuration examples in the documentation
rg -i "postgres.*config|host.*5432|database.*configdb" docs/ --type txt --type md | head -20Repository: asgardeo/thunder Length of output: 979 🏁 Script executed: # Look for any deployment.yaml examples with PostgreSQL configuration
rg -A 20 "type.*postgres" backend/ --type yaml | head -50Repository: asgardeo/thunder Length of output: 1251 🏁 Script executed: # Check if there's documentation about configuring databases in Thunder
fd -t f "*.md*" docs/content/guides/ | xargs grep -l -i "postgres\|database" | head -5Repository: asgardeo/thunder Length of output: 344 🏁 Script executed: # Look at what a PostgreSQL deployment.yaml should look like
cat backend/tests/resources/deployment.yaml | grep -A 10 "database:" | head -30Repository: asgardeo/thunder Length of output: 252 🏁 Script executed: # Check if there are any other guides that show PostgreSQL configuration examples
fd -t f "kubernetes" docs/content/guides/deployment-patterns/ 2>/dev/null | xargs cat 2>/dev/null | grep -A 15 "postgres\|configdb" | head -40Repository: asgardeo/thunder Length of output: 1062 🏁 Script executed: # Check the Helm values to see the PostgreSQL configuration structure
cat install/helm/values.yaml | grep -A 20 "database:"Repository: asgardeo/thunder Length of output: 891 🏁 Script executed: # Search for any example deployment.yaml files in docs
fd -t f "deployment.yaml" docs/ 2>/dev/nullRepository: asgardeo/thunder Length of output: 42 🏁 Script executed: # Look for references to how to configure database in Docker context
rg -B 5 -A 10 "deployment.yaml" docs/content/guides/deployment-patterns/docker.mdxRepository: asgardeo/thunder Length of output: 1103 🏁 Script executed: # Check if there's environment variable support for database configuration
rg -i "env\|getenv" backend/cmd/server/ -t go | grep -i "database\|postgres" | head -10Repository: asgardeo/thunder Length of output: 42 🏁 Script executed: # Look at the complete Docker section more carefully
sed -n '70,200p' docs/content/guides/deployment-patterns/docker.mdxRepository: asgardeo/thunder Length of output: 1722 🏁 Script executed: # Verify if the documentation mentions anywhere else how to use PostgreSQL with Docker
rg -i "postgres.*docker|docker.*postgres" docs/content/guides/Repository: asgardeo/thunder Length of output: 700 🏁 Script executed: # Check the docker compose file again and verify network setup
cat install/local-development/docker-compose.ymlRepository: asgardeo/thunder Length of output: 756 🏁 Script executed: # Look for networking configuration in the docker guide
rg -i "network\|docker.*compose\|compose.*network" docs/content/guides/deployment-patterns/docker.mdxRepository: asgardeo/thunder Length of output: 42 🏁 Script executed: # Check if there's a complete example deployment.yaml with PostgreSQL
fd -t f "*.yaml" install/local-development/Repository: asgardeo/thunder Length of output: 345 🏁 Script executed: # Look at how the Kubernetes guide handles PostgreSQL configuration to understand expected structure
sed -n '1,300p' docs/content/guides/deployment-patterns/kubernetes.mdx | grep -A 30 "PostgreSQL"Repository: asgardeo/thunder Length of output: 3284 🏁 Script executed: # Let's verify the complete workflow - check if there's a sample deployment.yaml in install/local-development
fd --glob "deployment*" install/local-development/Repository: asgardeo/thunder Length of output: 42 🏁 Script executed: # Check if the init.sql or other files in postgres-init give us hints about expected config
cat install/local-development/postgres-init/init.sql 2>/dev/null || echo "File not found"Repository: asgardeo/thunder Length of output: 443 🏁 Script executed: # Verify the networking - does Docker Compose auto-network or need manual setup?
rg "networks:" install/local-development/docker-compose.ymlRepository: asgardeo/thunder Length of output: 42 🏁 Script executed: # Check if there's any mention of how to connect Thunder container to postgres container
rg -i "depends_on\|link\|network" install/local-development/Repository: asgardeo/thunder Length of output: 42 🏁 Script executed: # Let's verify one more thing - check if there's a way to test the complete workflow
# by looking at integration tests or CI/CD that uses docker-compose
rg -i "docker-compose\|install/local-development" .github/ backend/tests/ --type yaml | head -10Repository: asgardeo/thunder Length of output: 42 🏁 Script executed: # Check if the documentation elsewhere mentions how to provide a deployment.yaml config for PostgreSQL
rg -B 5 -A 5 "hostname.*localhost\|host.*postgres" docs/content/ | grep -A 10 -B 10 "deployment.yaml"Repository: asgardeo/thunder Length of output: 42 External PostgreSQL section requires configuration step to connect Thunder to PostgreSQL The section shows starting PostgreSQL but omits the critical step of configuring Thunder to use it. Users following these steps would start the database but Thunder would still use SQLite by default. Add a step showing how to create and mount a Suggested addition 2. Start PostgreSQL in the background:
```bash
docker compose up -d
```
+3. Create a `deployment.yaml` file with PostgreSQL configuration:
+
+ ```yaml
+ database:
+ config:
+ type: postgres
+ hostname: postgres
+ port: 5432
+ name: configdb
+ username: asgthunder
+ password: asgthunder
+ sslmode: disable
+ runtime:
+ type: postgres
+ hostname: postgres
+ port: 5432
+ name: runtimedb
+ username: asgthunder
+ password: asgthunder
+ sslmode: disable
+ user:
+ type: postgres
+ hostname: postgres
+ port: 5432
+ name: userdb
+ username: asgthunder
+ password: asgthunder
+ sslmode: disable
+ ```
+
+4. Start Thunder with the PostgreSQL configuration:
+
+ ```bash
+ docker run --rm \
+ -p 8090:8090 \
+ -v $(pwd)/deployment.yaml:/opt/thunder/repository/conf/deployment.yaml \
+ ghcr.io/asgardeo/thunder:latest
+ ```
+
+5. View PostgreSQL logs:
-3. View PostgreSQL logs:Note: The hostname is 🤖 Prompt for AI Agents |
||
|
|
||
| ## Next Steps | ||
|
|
||
| - [Deploy Thunder on Kubernetes](./kubernetes) — Deploy Thunder to a Kubernetes cluster using Helm. | ||
| - [Deploy Thunder on OpenChoreo](./openchoreo) — Deploy Thunder on the OpenChoreo platform. | ||
Oops, something went wrong.
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.
🧩 Analysis chain
🏁 Script executed:
Repository: asgardeo/thunder
Length of output: 693
🏁 Script executed:
cat -n .vale.ini | head -30Repository: asgardeo/thunder
Length of output: 1005
🏁 Script executed:
Repository: asgardeo/thunder
Length of output: 556
Fix
BlockIgnoresregex pattern to match only frontmatter, not mid-document rules.The pattern
(?s)^---.*?---uses^which in multiline mode matches the start of any line, not the file start. Combined with DOTALL mode (?s), it matches from any---separator to the next one, incorrectly excluding mid-document content from Vale checks.Testing confirms the pattern matches multiple times in files with horizontal rules: in a sample with three
---pairs, it produces three matches instead of one. Files likedocs/content/community/contributing/overview.mdx(14 occurrences) anddocs/content/community/contributing/contributing-code/documentation-development/writing-documentation.mdx(20 occurrences) would have significant content sections incorrectly ignored.Replace
^with\Aon lines 12 and 26 to anchor only to the file start:Recommended fix
Apply to both
[*.md](line 12) and[*.mdx](line 26) sections.📝 Committable suggestion
🤖 Prompt for AI Agents