Skip to content

Docs: Enforce documentation style guide with spelling check and style fixes - #4690

Open
aravindtga wants to merge 1 commit into
kptdev:mainfrom
Nordix:enforce-style-guide
Open

Docs: Enforce documentation style guide with spelling check and style fixes#4690
aravindtga wants to merge 1 commit into
kptdev:mainfrom
Nordix:enforce-style-guide

Conversation

@aravindtga

Copy link
Copy Markdown
Contributor

Description

  • What changed: Added automated spelling check, fixed style violations, and documented the $ prefix convention.
  • Why it's needed: Issue Linter to enforce docs style guide #1652 requested a linter to enforce documentation style rules. This PR addresses all remaining unchecked items.
  • How it works: Uses golangci/misspell (the maintained fork used by golangci-lint) to check markdown files for spelling errors, integrated into CI via the existing docs workflow.

Related Issue(s)

Type of Change

  • Enhancement
  • Documentation

Checklist

  • Code follows project style guidelines
  • Self-reviewed changes
  • Tests added/updated
  • Documentation added/updated
  • All tests and gating checks pass

AI Disclosure

  • I have used AI in the creation of this PR.

If so, please describe how:

  • Kiro to investigate the issue, research tooling approaches (kubernetes/website, kustomize, Vale, codespell), implement the spelling check, and apply style fixes across the documentation.

@netlify

netlify Bot commented Aug 10, 2026

Copy link
Copy Markdown

Deploy Preview for kptdocs ready!

Name Link
🔨 Latest commit 32bc26b
🔍 Latest deploy log https://app.netlify.com/projects/kptdocs/deploys/6a7add7b1f463a000850c933
😎 Deploy Preview https://deploy-preview-4690--kptdocs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@aravindtga
aravindtga marked this pull request as ready for review August 10, 2026 13:44
@aravindtga
aravindtga requested review from a team August 10, 2026 13:44
@dosubot dosubot Bot added size:L This PR changes 100-499 lines, ignoring generated files. documentation Improvements or additions to documentation enhancement New feature or request labels Aug 10, 2026
@aravindtga aravindtga self-assigned this Aug 10, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good to me.

@dosubot dosubot Bot added the lgtm label Aug 10, 2026
… fixes

Signed-off-by: Aravindhan Ayyanathan <aravindhan.a@est.tech>
@aravindtga
aravindtga force-pushed the enforce-style-guide branch from b22acbb to 32bc26b Compare August 11, 2026 08:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request lgtm size:L This PR changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Linter to enforce docs style guide

3 participants