-
-
Notifications
You must be signed in to change notification settings - Fork 0
chore(docs): configure cspell/markdownlint and expand pre-commit; refresh docs #24
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
…resh docs - Add cspell custom dictionary and extend cspell.config.yaml (ignorePaths, dictionaryDefinitions, and words) to cover project-specific terms. - Introduce markdownlint config (.mdlrc, .mdl_style.rb) for consistent MD style. - Update .pre-commit-config.yaml: add check-merge-conflict, check-json, pretty-format-json, mixed-line-ending; scope/tune check-yaml; add requirements-txt-fixer and no-commit-to-branch. - Normalize and reword documentation across docs/* and README.md (ordered lists, headings, examples, and terminology). - Adjust docs/requirements.txt dependency pinning for mkdocs-material. Rationale: improve docs quality and consistency; enforce formatting and spelling in CI/pre-commit; reduce noise from false positives.
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.
Pull request overview
This PR improves documentation quality and consistency by configuring spell checking and markdown linting tools, expanding pre-commit hooks, and normalizing documentation formatting across the project.
Key Changes
- Enhanced tooling configuration: Added cspell spell checker with custom dictionary, markdownlint configuration for consistent Markdown style, and expanded pre-commit hooks
- Documentation normalization: Standardized ordered list numbering to use "1." format throughout all documentation files (Markdown auto-numbers these correctly)
- Pre-commit expansion: Added hooks for merge conflict detection, JSON validation/formatting, line ending normalization, requirements.txt fixing, and branch protection
Reviewed changes
Copilot reviewed 18 out of 18 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| cspell.config.yaml | Expanded ignore paths and added project-specific terms to the spell checker dictionary |
| .pre-commit-config.yaml | Added multiple new hooks for code quality checks and formatting |
| .mdlrc | Added markdownlint configuration file reference |
| .mdl_style.rb | Created markdownlint style rules (MD013 exclusion, MD007 indent, MD029 list style) |
| .cspell/custom-dictionary.txt | Added custom dictionary with Go-specific and project-specific terms |
| docs/requirements.txt | Reordered dependencies alphabetically |
| docs/docs/index.md | Normalized ordered lists to use "1." format; removed question mark from heading |
| docs/docs/getting-started/quickstart.md | Normalized ordered lists to use "1." format |
| docs/docs/features/stack-traces.md | Normalized ordered lists to use "1." format |
| docs/docs/features/observability.md | Normalized ordered lists to use "1." format |
| docs/docs/features/error-groups.md | Normalized ordered lists and fixed code block indentation |
| docs/docs/features/error-creation.md | Normalized ordered lists to use "1." format |
| docs/docs/features/circuit-breaker.md | Normalized ordered lists to use "1." format |
| docs/docs/api/overview.md | Normalized ordered lists to use "1." format |
| docs/docs/advanced/performance.md | Normalized ordered lists to use "1." format |
| docs/docs/advanced/error-types.md | Normalized ordered lists to use "1." format |
| docs/docs/advanced/error-strategies.md | Normalized ordered lists to use "1." format |
| README.md | Normalized ordered lists to use "1." format |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
.pre-commit-config.yaml
Outdated
| - id: end-of-file-fixer | ||
| - id: mixed-line-ending | ||
| - id: trailing-whitespace | ||
| - id: mixed-line-ending |
Copilot
AI
Dec 18, 2025
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.
The hook mixed-line-ending is declared twice in the configuration. Line 10 adds it, but it's duplicated on line 12. This will cause the hook to run twice unnecessarily, which could lead to confusion or performance issues.
| - id: mixed-line-ending |
| # default in next version, remove then | ||
| rule 'MD007', :indent => 3 | ||
|
|
||
| rule "MD029", style => "one" |
Copilot
AI
Dec 18, 2025
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.
Syntax error in Ruby hash syntax. The parameter should use hash rocket (=>) with a colon prefix for the key: :style => "one". The current syntax style => "one" is missing the colon before style.
| rule "MD029", style => "one" | |
| rule "MD029", :style => "one" |
- Deduplicate `mixed-line-ending` entry in `.pre-commit-config.yaml`. - Prevents the hook from running twice and reduces noise in commit output. - No code changes; configuration-only update.
- Deduplicate `mixed-line-ending` entry in `.pre-commit-config.yaml`. - Prevents the hook from running twice and reduces noise in commit output. - No code changes; configuration-only update.
Rationale: improve docs quality and consistency; enforce formatting and spelling in CI/pre-commit; reduce noise from false positives.