Skip to content

Conversation

@hyp3rd
Copy link
Owner

@hyp3rd hyp3rd commented Dec 18, 2025

  • 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.

…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.
Copilot AI review requested due to automatic review settings December 18, 2025 09:05
Copy link
Contributor

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.

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

  1. Enhanced tooling configuration: Added cspell spell checker with custom dictionary, markdownlint configuration for consistent Markdown style, and expanded pre-commit hooks
  2. Documentation normalization: Standardized ordered list numbering to use "1." format throughout all documentation files (Markdown auto-numbers these correctly)
  3. 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.

- id: end-of-file-fixer
- id: mixed-line-ending
- id: trailing-whitespace
- id: mixed-line-ending
Copy link

Copilot AI Dec 18, 2025

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.

Suggested change
- id: mixed-line-ending

Copilot uses AI. Check for mistakes.
# default in next version, remove then
rule 'MD007', :indent => 3

rule "MD029", style => "one"
Copy link

Copilot AI Dec 18, 2025

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.

Suggested change
rule "MD029", style => "one"
rule "MD029", :style => "one"

Copilot uses AI. Check for mistakes.
- 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.
@hyp3rd hyp3rd merged commit f219c28 into main Dec 19, 2025
8 of 9 checks passed
@hyp3rd hyp3rd deleted the feat/pre-commit branch December 19, 2025 15:05
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.

2 participants