Grids: create auto doc script#32706
Merged
anna-shakhova merged 4 commits intoDevExpress:26_1from Feb 27, 2026
Merged
Conversation
anna-shakhova
changed the title
Contributor
There was a problem hiding this comment.
Pull request overview
This PR introduces an automated documentation generator for the Grid Core architecture. The script analyzes TypeScript source files in the grid_core directory to create both JSON and interactive HTML visualizations showing module structure, class hierarchies, inheritance chains, and runtime dependencies.
Changes:
- Adds a comprehensive TypeScript-based architecture documentation generator with AST parsing capabilities
- Generates both structured JSON data and an interactive Cytoscape.js-based HTML visualization
- Creates a new
__docs__directory structure with scripts and configuration for documentation generation
Reviewed changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 8 comments.
Show a summary per file
| File | Description |
|---|---|
| packages/devextreme/js/__internal/grids/docs/tsconfig.json | TypeScript configuration for the documentation scripts |
| packages/devextreme/js/__internal/grids/docs/scripts/types.ts | TypeScript type definitions for architecture data structures |
| packages/devextreme/js/__internal/grids/docs/scripts/resolver.ts | Logic for resolving class aliases, building registries, and normalizing references |
| packages/devextreme/js/__internal/grids/docs/scripts/parser.ts | AST parsing logic for extracting class hierarchies and module definitions |
| packages/devextreme/js/__internal/grids/docs/scripts/html-template.ts | HTML template generator with embedded Cytoscape.js visualization |
| packages/devextreme/js/__internal/grids/docs/scripts/graph-builder.ts | Cytoscape.js graph element builder for visualization |
| packages/devextreme/js/__internal/grids/docs/scripts/generate-architecture-doc.ts | Main entry point script orchestrating the documentation generation |
| packages/devextreme/js/__internal/grids/docs/scripts/constants.ts | Configuration constants including paths, feature areas, and class mappings |
| packages/devextreme/js/__internal/grids/docs/scripts/cli.ts | CLI argument parser supporting --json and --html flags |
| packages/devextreme/.gitignore | Adds artifacts directory to gitignore |
anna-shakhova
force-pushed
the
26_1__grids_core_auto_docs_script
branch
from
c80cf53 to
415b13e
Compare
anna-shakhova
force-pushed
the
26_1__grids_core_auto_docs_script
branch
from
e06eccc to
38daee7
Compare
dmirgaev
approved these changes
Feb 27, 2026
anna-shakhova
changed the title
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.