Skip to content

Conversation

dharmesh-hemaram
Copy link
Member

This pull request introduces a comprehensive documentation build and validation system, adds configuration and data files for the documentation site, and updates the project dependencies and scripts to support these new features. The main themes are documentation workflow automation, site configuration, and dependency management.

Documentation workflow automation:

  • Added a new GitHub Actions workflow (.github/workflows/docs.yml) to automate building, validating, and deploying documentation, including HTML validation and link checking.
  • Introduced a Node.js script (build/vnu-jar.mjs) to run vnu-jar for HTML validation, with custom ignore patterns for known issues.

Site configuration and data files:

  • Added config.yml for site-wide configuration, including metadata, analytics, Algolia search, CDN links, and download URLs.
  • Added several data files (site/data/breakpoints.yml, site/data/colors.yml, site/data/grays.yml, site/data/plugins.yml, site/data/policy.yml) to support documentation content such as breakpoints, colors, plugins, and privacy policy. [1] [2] [3] [4] [5]
  • Added Astro config (site/astro.config.ts) for documentation site build, including integration with plugins and environment-based site URL selection.
  • Added Prettier configuration for documentation formatting (site/.prettierrc.json).

Dependency and script updates:

  • Updated package.json to add scripts for building, linting, formatting, serving, and validating documentation, and added new dependencies for Astro, documentation tooling, and HTML validation. [1] [2] [3] [4] [5]

- Added various PNG images for configuration, commands, and UI elements.
- Included SVG icons for branding and functionality.
- Introduced JavaScript files for color mode toggling and form validation.
- Added service worker script for improved offline capabilities.
- Created TypeScript configuration for better module resolution.
- Included video recording asset for demonstration purposes.
- Updated favicon assets for better branding across platforms.
- Removed example-float.md and example-xpath.md callouts, and recreated them with improved formatting and structure.
- Deleted subscribe-callout.md and reintroduced it with better content organization.
- Updated permissions documentation for clarity and consistency in formatting.
- Enhanced action settings and element finder documentation with clearer examples and improved formatting.
- Improved bulk export and import documentation for better understanding of functionality.
- Refined configuration settings and retry settings documentation for clarity.
- Added new IncludeMdx shortcode for better MDX file inclusion.
- Cleaned up config.ts and auto-import.d.ts files by removing unused properties.
@Copilot Copilot AI review requested due to automatic review settings August 12, 2025 07:43
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

@sonarqubecloud
Copy link

Quality Gate Failed Quality Gate failed

Failed conditions
C Reliability Rating on New Code (required ≥ A)

See analysis details on SonarQube Cloud

Catch issues before they fail your Quality Gate with our IDE extension SonarQube for IDE

@nx-cloud
Copy link

nx-cloud bot commented Aug 13, 2025

View your CI Pipeline Execution ↗ for commit ef816c7

Command Status Duration Result
nx affected --target=typecheck --parallel=3 --v... ✅ Succeeded 29s View ↗
nx affected --target=test --parallel=3 --verbos... ✅ Succeeded 35s View ↗
nx affected --target=lint --parallel=3 --verbos... ✅ Succeeded 21s View ↗

☁️ Nx Cloud last updated this comment at 2025-08-13 12:31:07 UTC

@codacy-production
Copy link

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation Diff coverage
Report missing for 3e0675e1
Coverage variation details
Coverable lines Covered lines Coverage
Common ancestor commit (3e0675e) Report Missing Report Missing Report Missing
Head commit (ef816c7) 1750 120 6.86%

Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: <coverage of head commit> - <coverage of common ancestor commit>

Diff coverage details
Coverable lines Covered lines Diff coverage
Pull request (#654) 0 0 ∅ (not applicable)

Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: <covered lines added or modified>/<coverable lines added or modified> * 100%

See your quality gate settings    Change summary preferences

Footnotes

  1. Codacy didn't receive coverage data for the commit, or there was an error processing the received data. Check your integration for errors and validate that your coverage setup is correct.

@dharmesh-hemaram dharmesh-hemaram merged commit c258fdb into main Aug 13, 2025
7 of 8 checks passed
@dharmesh-hemaram dharmesh-hemaram deleted the docs branch August 13, 2025 12:45
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