Doc lint and prism check #18
Merged
Conversation
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
Introduces .stylelintrc.json and eslint.config.js for consistent code style and linting in the docs. Updates VitePress config and theme files for improved formatting and copyright link. Adds related devDependencies to package.json and package-lock.json.
Documented the process for reviewing Prism releases for breaking changes in AGENTS.md, including key integration points and resilience rationale. Added a compatibility tracking table to NOTES.md to record review dates, versions, and findings.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
This pull request introduces several improvements to the Atlas documentation project, focusing on documentation clarity, dependency compatibility tracking, and the addition of code quality tooling for both JavaScript/TypeScript and CSS. The changes enhance maintainability, ensure ongoing compatibility with the Prism library, and enforce consistent coding standards in the documentation codebase.
Documentation and Compatibility Tracking:
AGENTS.md, outlining the process for reviewing Prism releases, assessing their impact on Atlas, and documenting findings. This includes a table of key integration files and an explanation of Atlas's resilience to upstream changes.NOTES.mdto log review dates, Prism versions, compatibility status, and notes on changes, supporting ongoing maintenance.Code Quality Tooling and Configuration:
docs/package.json, including commands for linting and fixing JavaScript/TypeScript and CSS files. Also added relevant dev dependencies for code quality enforcement.eslint.config.jsusing@eslint/jsandtypescript-eslintfor recommended linting rules and project-specific settings..stylelintrc.jsonfile to configure Stylelint with standard and stylistic rules, plugins, and ignore patterns for the documentation CSS.Minor Documentation and Style Updates:
docs/.vitepress/config.mtsto use the correct author link.docs/.vitepress/config.mts,docs/.vitepress/theme/custom.css, anddocs/.vitepress/theme/index.tsfor consistency and readability. [1] [2] [3] [4] [5]These changes collectively improve the reliability, maintainability, and clarity of the Atlas documentation and its supporting codebase.