Skip to content

Docs: Migrate internal links to relref and fix spelling errors - #4700

Merged
efiacor merged 1 commit into
kptdev:mainfrom
Nordix:relref-migration-and-spelling-fixes
Aug 14, 2026
Merged

Docs: Migrate internal links to relref and fix spelling errors#4700
efiacor merged 1 commit into
kptdev:mainfrom
Nordix:relref-migration-and-spelling-fixes

Conversation

@aravindtga

Copy link
Copy Markdown
Contributor

Description

  • What changed: Migrated all internal documentation links from plain markdown paths to Hugo {{% relref %}} shortcodes, and fixed 4 spelling errors not covered by Docs: Enforce documentation style guide with spelling check and style fixes #4690.
  • Why it's needed: Plain markdown links had no build-time validation broken internal links would only be caught by manually browsing the site. Hugo's relref fails the build immediately if a target page doesn't exist, providing the same approach used in porch documentation.
  • How it works:
    • Converted 55+ internal links (both absolute /path/... and relative ../path/...) to {{% relref "/absolute/path" %}} syntax
    • Fixed a double-slash typo in book/04-using-functions/_index.md
    • Fixed spelling
    • Hugo build passes cleanly (127 pages, 0 errors)

Related Issue(s)

Type of Change

  • 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 identify all internal links requiring migration, perform the conversion, validate with Hugo build, and run spelling checks.

Signed-off-by: Aravindhan Ayyanathan <aravindhan.a@est.tech>
@netlify

netlify Bot commented Aug 13, 2026

Copy link
Copy Markdown

Deploy Preview for kptdocs ready!

Name Link
🔨 Latest commit 432c1a2
🔍 Latest deploy log https://app.netlify.com/projects/kptdocs/deploys/6a7de9c4b3ebc300085fcc33
😎 Deploy Preview https://deploy-preview-4700--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 self-assigned this Aug 13, 2026
@aravindtga
aravindtga marked this pull request as ready for review August 13, 2026 16:00
@aravindtga
aravindtga requested review from a team August 13, 2026 16:00
@dosubot dosubot Bot added size:L This PR changes 100-499 lines, ignoring generated files. documentation Improvements or additions to documentation labels Aug 13, 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.

great work. brings porch and kpt docs closer aligned + fixes local link validation issue. now just for external URL's.

@dosubot dosubot Bot added the lgtm label Aug 14, 2026
@efiacor
efiacor merged commit 01ffc82 into kptdev:main Aug 14, 2026
26 checks passed
@efiacor
efiacor deleted the relref-migration-and-spelling-fixes branch August 14, 2026 11:32
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 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.

3 participants