Skip to content

Document link validation enforcement boundaries - #3031

Merged
ktsaou merged 1 commit into
masterfrom
docs/link-validation-policy
Aug 22, 2026
Merged

Document link validation enforcement boundaries#3031
ktsaou merged 1 commit into
masterfrom
docs/link-validation-policy

Conversation

@ktsaou

@ktsaou ktsaou commented Aug 22, 2026

Copy link
Copy Markdown
Member

Summary

  • add the root Learn agent instructions
  • define same-site links as a required standalone merge check
  • define cross-Netdata-site links as a separate advisory check
  • check only newly introduced third-party targets advisorially on pull requests
  • reserve complete third-party reconciliation for a weekly job with unresolved automation decisions
  • keep every link check independent from Netlify

Validation

  • git diff --check
  • documentation-only change; no workflow, branch-protection, Netlify, or public-site behavior changed

Summary by cubic

Documents Learn link integrity enforcement and keeps link checks independent from Netlify. This sets required vs advisory jobs without changing workflows yet.

  • Validate same-site links against rendered Learn output in a standalone required GitHub job; failures block merges but not deploy previews.
  • Run cross-Netdata-site link checks in a separate advisory job; findings cannot block merges or deployments.
  • On pull requests, check only newly introduced third‑party targets in an advisory job; reconcile the full third‑party inventory weekly.
  • Validate public routes using rendered output, not source Markdown; fix issues in the owning source or generator.
  • Enforcement is pending; standalone jobs and branch protection will be added later. This PR adds documentation only.

Written for commit db8270e. Summary will update on new commits.

Review in cubic

Summary by CodeRabbit

  • Documentation
    • Added repository guidance for maintaining the Netdata Learn documentation site.
    • Documented link validation rules, third-party link checks, implementation-status requirements, and change-management practices.

@netlify

netlify Bot commented Aug 22, 2026

Copy link
Copy Markdown

Deploy Preview for netdata-docusaurus ready!

Name Link
🔨 Latest commit db8270e
🔍 Latest deploy log https://app.netlify.com/projects/netdata-docusaurus/deploys/6a89343cb09f5f0008f545ef
😎 Deploy Preview https://deploy-preview-3031--netdata-docusaurus.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

@coderabbitai

coderabbitai Bot commented Aug 22, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 025a376c-e91c-4c47-9f9d-9f024c83509d

📥 Commits

Reviewing files that changed from the base of the PR and between 56331bd and db8270e.

📒 Files selected for processing (1)
  • AGENTS.md

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

Added AGENTS.md with repository rules for link validation, GitHub checks, third-party reconciliation, implementation status, and source-focused changes.

Changes

Repository Workflow Guidance

Layer / File(s) Summary
Repository workflow rules
AGENTS.md
Defines rendered-route link integrity checks, independent GitHub validation jobs, merge and deployment blocking behavior, weekly third-party reconciliation, implementation-status constraints, and change-discipline requirements.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Merge Risk: ⚪ Minimal · up to db827

This documentation-only change defines future link-validation boundaries without changing workflows, deployment behavior, or public-site behavior; no actionable merge-blocking risk remains.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the pull request's main change: documenting link-validation enforcement boundaries.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/link-validation-policy

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@ktsaou
ktsaou merged commit 24e2e2b into master Aug 22, 2026
9 checks passed
@ktsaou
ktsaou deleted the docs/link-validation-policy branch August 22, 2026 05:38
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.

1 participant