Skip to content

chore: promote develop to main#1132

Merged
GrammaTonic merged 7 commits intomainfrom
develop
Mar 1, 2026
Merged

chore: promote develop to main#1132
GrammaTonic merged 7 commits intomainfrom
develop

Conversation

@GrammaTonic
Copy link
Owner

@GrammaTonic GrammaTonic commented Mar 1, 2026

Promote develop to main

Summary

Promote 6 commits from develop into main covering docs-validation hardening, CI improvements, and documentation fixes.

Commits included

Commit Description
26f6e6c fix: resolve dead links flagged by validate-docs CI job (#1131)
3371ac1 feat: add job summary with fix guidance to validate-docs workflow
3983b2a perf: replace super-linter with markdownlint-cli2-action (#1130)
c9a28f8 fix: add ignore patterns for localhost and private project URLs (#1129)
872e0c7 fix: harden docs-validation and auto-sync-docs workflows (#1127)
4ef1df0 docs: fix 5 broken documentation links from maintenance run 229 (#1126)

Merge Strategy

Regular merge (NOT squash) — preserves shared commit history between develop and main, so no back-sync is needed.

Checklist

  • All CI checks passing on develop
  • No merge conflicts with main
  • Using regular merge strategy (not squash)

- PHASE2_IMPLEMENTATION_SUMMARY.md: fix relative paths to tests/integration/
  (./tests → ../../tests, resolves from docs/features/ correctly)
- PROMETHEUS_TIMELINE_VISUAL.md: replace absolute /plan/ path with relative
  ../../plan/ path
- prometheus-metrics-phase1.md: replace dead SUPPORT.md link with CONTRIBUTING.md
- PERFORMANCE_OPTIMIZATIONS.md: remove dead PARALLEL_NPM_RESULTS.md link
  (rejected feature, results file never created)
* fix: harden docs-validation and auto-sync-docs workflows

- Fix critical bug: super-linter FILTER_REGEX_INCLUDE/EXCLUDE used glob
  syntax instead of regex, linter was effectively scanning zero files.
  Changed to proper regex: (docs|wiki-content)/.* and docs/archive/.*
- Fix link-check silently swallowing failures: remove || true from
  markdown-link-check invocations so broken links actually fail the build
- Pin markdown-link-check to v3.14.2 to prevent supply chain attacks
- Add .markdown-link-check.json config with retry-on-429, timeout, and
  ignore patterns for flaky URLs (actions/runs, settings, wiki pages)
- Pin super-linter to SHA (12150456) instead of mutable v7 tag
- Add permissions block (contents: read, statuses: write) to
  docs-validation.yml to prevent overly broad default token scope
- Add concurrency group to cancel in-progress runs on rapid PR pushes
- Optimize checkout: fetch-depth 1 plus targeted base SHA fetch
- Fix patch diff: use PR base SHA instead of always diffing origin/main
- Integrate scripts/check-docs-structure.sh into CI pipeline
- Fix VALIDATE_MD to VALIDATE_MARKDOWN env var for super-linter v7
- Apply same fixes to auto-sync-docs.yml (identical copy-pasted bugs)

* fix: address Gemini review comments on link-check config

- Remove api.github.com from text/html header rule since the GitHub API
  serves JSON and would return errors with Accept: text/html
- Remove 301/302 from aliveStatusCodes since markdown-link-check follows
  redirects by default and including them could mask broken destinations
Add ignore patterns for localhost URLs (documentation examples not
reachable in CI) and GitHub user project board URLs (private/404 in CI).
Fixes docs-validation failure on PR #1128.
Replace super-linter with markdownlint-cli2-action for ~95% faster Markdown linting. Add workflow_dispatch trigger for manual runs.
- Add continue-on-error to all validation steps so every check runs
- Capture output from structure, outdated refs, and link checks
- Generate GITHUB_STEP_SUMMARY with status table and per-check details
- Include 'How to fix' guidance for each failure type
- Final gate step fails the job if any check failed
Fix all validate-docs CI failures: auto-fix 656+ markdownlint errors, disable noisy rules, fix heading structure, repair dead links, strengthen link-check config. 0 errors across 46 files.
@gemini-code-assist
Copy link

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request promotes the latest integrated changes from the develop branch to main, primarily focusing on comprehensive documentation enhancements and maintenance. The updates ensure that all guides, feature specifications, and release notes are consistent, well-formatted, and reflect the current state of the project's CI/CD, security, and performance optimizations. This merge solidifies the project's documentation foundation, making it easier for contributors and users to understand and interact with the codebase.

Highlights

  • Documentation Updates: Numerous documentation files across docs/ and wiki-content/ have been updated for improved readability, consistency, and accuracy, including formatting adjustments, corrected numbering, and updated links.
  • New Markdown Linting and Link Checking: New configuration files for markdown-link-check and markdownlint-cli2 were added to enhance documentation quality by enforcing style guidelines and verifying external links.
  • Branch Protection Clarification: The docs/SETUP_SUMMARY.md file was updated to correctly identify the 'Develop Branch' as the integration branch and streamline its protection details.
  • Performance Optimization Documentation: Documentation related to performance baselines and optimizations received formatting improvements, ensuring clarity in identifying issues and tracking completed work.
  • Security Workflow Refinements: Documentation for security advisories and code scanning fixes was updated, including details on action version pinning, multi-arch support, and enhanced reporting.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog
  • .markdown-link-check.json
    • Added a new configuration file to enable automated checking of links within markdown files.
  • .markdownlint-cli2.jsonc
    • Added a new configuration file for markdownlint-cli2, replacing super-linter for Markdown validation with specific rule overrides.
  • docs/BRANCH_PROTECTION_GUIDE.md
    • Updated section numbering and added blank lines for improved readability.
  • docs/CHROME_RUNNER_X86_DEPLOYMENT.md
    • Adjusted headings and added blank lines to enhance document structure and readability.
  • docs/CODE_SCANNING_FIXES.md
    • Added blank lines for better visual separation of content sections.
  • docs/DEPLOYMENT.md
    • Inserted blank lines to improve the readability of code blocks and sections.
  • docs/PERFORMANCE_BASELINE.md
    • Added blank lines to improve section readability and corrected numbering in optimization priorities.
  • docs/PERFORMANCE_OPTIMIZATIONS.md
    • Added blank lines for improved readability and updated a link in the 'Rejected Optimizations' section.
  • docs/PERFORMANCE_RESULTS.md
    • Added blank lines to enhance the visual presentation of content.
  • docs/README.md
    • Added blank lines for improved readability and consistent formatting.
  • docs/SETUP_SUMMARY.md
    • Corrected the branch name from 'Main Branch' to 'Develop Branch' in the repository structure description.
    • Removed specific required status checks and review settings from the 'Develop Branch Protection' section for simplification.
  • docs/VERSION_OVERVIEW.md
    • Added a blank line for improved readability.
  • docs/chrome-runner.md
    • Promoted a subheading to a main heading for better document hierarchy.
  • docs/community/CONTRIBUTING.md
    • Added blank lines around code blocks and list items for enhanced readability.
  • docs/examples/update-docs-example.md
    • Changed a comment from a heading format to a regular comment for consistency.
  • docs/features/CHROME_RUNNER_FEATURE.md
    • Added a blank line for improved readability.
  • docs/features/DEVELOPMENT_WORKFLOW.md
    • Added blank lines to improve the readability of content sections.
  • docs/features/GRAFANA_DASHBOARD_METRICS.md
    • Added blank lines for improved readability and updated a link for Netcat Usage Guide.
  • docs/features/MULTI_ARCH_CONTAINERS.md
    • Added blank lines to improve the readability of content sections.
  • docs/features/PHASE1_COMPLETION_SUMMARY.md
    • Added blank lines to improve the readability of content sections.
  • docs/features/PHASE2_IMPLEMENTATION_SUMMARY.md
    • Corrected numbering for a file in the 'Testing Infrastructure' section.
    • Added blank lines to improve the readability of content sections.
  • docs/features/PROMETHEUS_IMPROVEMENTS.md
    • Added blank lines to improve the readability of content sections.
    • Updated a link for GitHub Actions Monitoring.
  • docs/features/PROMETHEUS_ROADMAP.md
    • Added blank lines to improve the readability of content sections.
  • docs/features/PROMETHEUS_TIMELINE_VISUAL.md
    • Updated a relative link to an implementation plan document.
    • Added blank lines to improve the readability of content sections.
  • docs/features/SECURITY_ADVISORIES_IMPLEMENTATION_GUIDE.md
    • Added blank lines to improve the readability of content sections.
  • docs/features/SECURITY_ADVISORIES_REFACTORING.md
    • Added blank lines to improve the readability of content sections.
  • docs/features/prometheus-metrics-phase1.md
    • Changed a link from SUPPORT.md to CONTRIBUTING.md for accuracy.
    • Added blank lines to improve the readability of content sections.
  • docs/releases/CHANGELOG.md
    • Added blank lines for improved readability and adjusted list item formatting.
  • docs/releases/RELEASE_NOTES_v1.1.0.md
    • Added blank lines for improved readability.
  • docs/releases/RELEASE_NOTES_v1.1.1.md
    • Corrected a character in the impact description for clarity.
    • Added blank lines for improved readability.
  • docs/releases/RELEASE_NOTES_v2.0.2.md
    • Added blank lines for improved readability.
  • docs/releases/RELEASE_NOTES_v2.1.0.md
    • Added blank lines for improved readability.
  • docs/releases/RELEASE_NOTES_v2.2.0.md
    • Changed a string literal formatting for consistency.
    • Added blank lines for improved readability.
  • docs/setup/quick-start.md
    • Added blank lines to improve the readability of content sections.
  • wiki-content/Chrome-Runner.md
    • Added a blank line for improved readability.
  • wiki-content/Common-Issues.md
    • Corrected numbering in several troubleshooting sections for accuracy.
  • wiki-content/Docker-Configuration.md
    • Added a blank line for improved readability.
  • wiki-content/Home.md
    • Added a blank line for improved readability.
  • wiki-content/Installation-Guide.md
    • Promoted a subheading to a main heading for better document hierarchy.
    • Added blank lines for improved readability.
    • Corrected numbering in a section.
Ignored Files
  • Ignored by pattern: .github/workflows/** (2)
    • .github/workflows/auto-sync-docs.yml
    • .github/workflows/docs-validation.yml
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request promotes a series of commits from develop to main, primarily focused on documentation improvements, CI hardening, and new configurations. The changes largely enhance readability and fix links. However, I've identified several instances of incorrect numbering in ordered lists within the markdown documentation. These should be corrected to ensure clarity and correctness.

Comment on lines +332 to +335
2. **Optimize npm patching** - Single consolidated patch operation
3. **Parallel test execution** - Run tests during/after builds
4. **Dependency caching in CI/CD** - Cache apt, npm, pip packages
5. **Version pinning** - Reproducible builds, better caching

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The numbering in this list is incorrect. It should be sequential (7, 8, 9, 10) instead of restarting from 2.

Suggested change
2. **Optimize npm patching** - Single consolidated patch operation
3. **Parallel test execution** - Run tests during/after builds
4. **Dependency caching in CI/CD** - Cache apt, npm, pip packages
5. **Version pinning** - Reproducible builds, better caching
7. **Optimize npm patching** - Single consolidated patch operation
8. **Parallel test execution** - Run tests during/after builds
9. **Dependency caching in CI/CD** - Cache apt, npm, pip packages
10. **Version pinning** - Reproducible builds, better caching

Comment on lines +340 to +343
2. **Advanced caching strategies** - Remote cache, registry cache
3. **Resource limit tuning** - CPU/memory optimization
4. **Startup time optimization** - Lazy initialization patterns
5. **Alternative base images** - Alpine, distroless evaluation

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The numbering in this list is incorrect. It should be sequential (12, 13, 14, 15) instead of restarting from 2.

Suggested change
2. **Advanced caching strategies** - Remote cache, registry cache
3. **Resource limit tuning** - CPU/memory optimization
4. **Startup time optimization** - Lazy initialization patterns
5. **Alternative base images** - Alpine, distroless evaluation
12. **Advanced caching strategies** - Remote cache, registry cache
13. **Resource limit tuning** - CPU/memory optimization
14. **Startup time optimization** - Lazy initialization patterns
15. **Alternative base images** - Alpine, distroless evaluation

Comment on lines +422 to +424
2. **Large image sizes:** 2-4GB per variant
3. **Slow builds:** 5-9 minutes for Chrome variants
4. **Duplicate installations:** Playwright installs browsers when Chrome exists

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The numbering in this list is incorrect. It should be sequential (6, 7, 8) instead of restarting from 2.

Suggested change
2. **Large image sizes:** 2-4GB per variant
3. **Slow builds:** 5-9 minutes for Chrome variants
4. **Duplicate installations:** Playwright installs browsers when Chrome exists
6. **Large image sizes:** 2-4GB per variant
7. **Slow builds:** 5-9 minutes for Chrome variants
8. **Duplicate installations:** Playwright installs browsers when Chrome exists

Comment on lines +429 to +430
2. **Documentation:** Missing inline comments for complex operations
3. **Health check tuning:** 60s start period could be optimized

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The numbering in this list is incorrect. It should be sequential (10, 11) instead of restarting from 2.

Suggested change
2. **Documentation:** Missing inline comments for complex operations
3. **Health check tuning:** 60s start period could be optimized
10. **Documentation:** Missing inline comments for complex operations
11. **Health check tuning:** 60s start period could be optimized

Comment on lines +460 to +462
2. **Remote cache** - Share cache across CI/CD runners
3. **Registry cache** - Use GitHub Container Registry as cache backend
4. **Custom runner distribution** - Pre-built runner binary

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The numbering in this list is incorrect. It should be sequential (5, 6, 7) instead of restarting from 2. Also, the number 4 is repeated.

Suggested change
2. **Remote cache** - Share cache across CI/CD runners
3. **Registry cache** - Use GitHub Container Registry as cache backend
4. **Custom runner distribution** - Pre-built runner binary
5. **Remote cache** - Share cache across CI/CD runners
6. **Registry cache** - Use GitHub Container Registry as cache backend
7. **Custom runner distribution** - Pre-built runner binary

Comment on lines +327 to 332
1. **Cache size monitoring** - GitHub Actions 10GB cache limit
- **Current usage:** Unknown (need to monitor)
- **Action:** Add cache size reporting to workflow
3. **Cache eviction** - 7-day limit may affect infrequent builds

2. **Cache eviction** - 7-day limit may affect infrequent builds
- **Mitigation:** Regular scheduled builds to keep cache warm

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The numbering in this list is incorrect. It should be sequential (2, 3) instead of restarting from 1.

Suggested change
1. **Cache size monitoring** - GitHub Actions 10GB cache limit
- **Current usage:** Unknown (need to monitor)
- **Action:** Add cache size reporting to workflow
3. **Cache eviction** - 7-day limit may affect infrequent builds
2. **Cache eviction** - 7-day limit may affect infrequent builds
- **Mitigation:** Regular scheduled builds to keep cache warm
2. **Cache size monitoring** - GitHub Actions 10GB cache limit
- **Current usage:** Unknown (need to monitor)
- **Action:** Add cache size reporting to workflow
3. **Cache eviction** - 7-day limit may affect infrequent builds
- **Mitigation:** Regular scheduled builds to keep cache warm

- Verifies no port conflicts

7. **tests/integration/PHASE2_TESTING_GUIDE.md** (300+ lines)
2. **tests/integration/PHASE2_TESTING_GUIDE.md** (300+ lines)

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The numbering for this list item is incorrect. It should be 7. to follow the preceding item numbered 6..

Suggested change
2. **tests/integration/PHASE2_TESTING_GUIDE.md** (300+ lines)
7. **tests/integration/PHASE2_TESTING_GUIDE.md** (300+ lines)


<!-- Security Configuration doc not available. Link removed for CI/CD compliance. -->
4. **[Production Deployment](Production-Deployment.md)** - Production checklist
1. **[Production Deployment](Production-Deployment.md)** - Production checklist

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The numbering in this list is incorrect. This item should be numbered 3. to maintain sequential order.

Suggested change
1. **[Production Deployment](Production-Deployment.md)** - Production checklist
3. **[Production Deployment](Production-Deployment.md)** - Production checklist

Add /discussions URL ignore pattern to fix validate-docs CI failures
@GrammaTonic GrammaTonic merged commit ce024e3 into main Mar 1, 2026
22 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant