Skip to content
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

Format and lint all docs #5336

Merged
merged 4 commits into from
Jan 22, 2025
Merged

Conversation

danbarr
Copy link
Contributor

@danbarr danbarr commented Jan 22, 2025

Summary

Format and lint all docs files per the new style guide.

This is not a full language/voice review, just the automated fixes, and simple items like normalizing title/heading sentence case.

Also resolves two lingering comments from #5320:

  • Re-enable no-duplicate-heading markdownlint rule
  • Fix order of operations in docs/README.md

Change Type

  • Bug fix (resolves an issue without affecting existing features)
  • Feature (adds new functionality without breaking changes)
  • Breaking change (may impact existing functionalities or require documentation updates)
  • Documentation (updates or additions to documentation)
  • Refactoring or test improvements (no bug fixes or new functionality)

Testing

Ran all format/lint checks and confirmed site builds successfully.

Review Checklist:

  • Reviewed my own code for quality and clarity.
  • Added comments to complex or tricky code sections.
  • Updated any affected documentation.
  • Included tests that validate the fix or feature.
  • Checked that related changes are merged.

@danbarr danbarr requested a review from a team as a code owner January 22, 2025 02:03
@coveralls
Copy link

Coverage Status

coverage: 56.635%. remained the same
when pulling 761d3e0 on danbarr:docs/format-all-docs
into a00a92f on mindersec:main.

@evankanderson evankanderson merged commit 990e267 into mindersec:main Jan 22, 2025
24 checks passed
@danbarr danbarr deleted the docs/format-all-docs branch January 22, 2025 21:18
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.

4 participants