Skip to content

Docs: Move contributing guide to root and update developer documentation#792

Open
HARSHVARANDANI wants to merge 3 commits into
urunc-dev:mainfrom
HARSHVARANDANI:docs/root-contributing-guide
Open

Docs: Move contributing guide to root and update developer documentation#792
HARSHVARANDANI wants to merge 3 commits into
urunc-dev:mainfrom
HARSHVARANDANI:docs/root-contributing-guide

Conversation

@HARSHVARANDANI

@HARSHVARANDANI HARSHVARANDANI commented Jun 28, 2026

Copy link
Copy Markdown

Description

This PR makes the root CONTRIBUTING.md the single source of truth for the project's contribution guidelines.

Previously, the root CONTRIBUTING.md only redirected contributors to docs/developer-guide/contribute.md. Since GitHub automatically surfaces the root CONTRIBUTING.md when users open issues and pull requests, contributors would not immediately see the project's contribution guidelines.

This change:

  • Moves the complete contribution guide to the root CONTRIBUTING.md.
  • Configures MkDocs to include the root CONTRIBUTING.md in the Developer Guide using pymdownx.snippets, eliminating duplicate documentation.
  • Configures the pymdownx.snippets base_path so the root file can be referenced from the documentation.

This ensures contributors receive the full guidelines directly on GitHub while maintaining only a single copy of the documentation.

Related issues

How was this tested?

  • Verified that the documentation site builds successfully with:

    uv run mkdocs serve
  • Confirmed that the Developer Guide renders the contents of the root CONTRIBUTING.md.

LLM usage

N/A

Checklist

  • I have read the contribution guide.
  • The linter passes locally (make lint).
  • The e2e tests of at least one tool pass locally (make test_ctr, make test_nerdctl, make test_docker, make test_crictl).
  • If LLMs were used: I have read the llm policy.

Signed-off-by: HARSHVARANDANI <hpvarandani@gmail.com>
Signed-off-by: HARSHVARANDANI <hpvarandani@gmail.com>
Signed-off-by: HARSHVARANDANI <hpvarandani@gmail.com>
@netlify

netlify Bot commented Jun 28, 2026

Copy link
Copy Markdown

Deploy Preview for urunc ready!

Name Link
🔨 Latest commit 3e4018d
🔍 Latest deploy log https://app.netlify.com/projects/urunc/deploys/6a40c59914a49d0008693db1
😎 Deploy Preview https://deploy-preview-792--urunc.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.

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.

Enrich root CONTRIBUTING.md and reference it from mkdocs to avoid duplication [Docs]

1 participant