Skip to content

docs(contributing): document pr base branch and mdx page format - #2136

Open
youssefea wants to merge 3 commits into
masterfrom
docs/devrel-859-new-docs-org-pages-pr-branch
Open

youssefea wants to merge 3 commits into
masterfrom
docs/devrel-859-new-docs-org-pages-pr-branch

Conversation

@youssefea

Copy link
Copy Markdown
Contributor

What changed? Why?

  • Adds an "Opening a Pull Request" section to docs/contribution-guidelines.md. It says to open PRs against master, to create new pages as .mdx files because the Docs Style / Conformance check and orphan detection only cover .mdx files, and that snippets and .mintignore files are exempt from page-level lint rules. It also notes what node scripts/lint-mdx.js checks when you run it with no arguments.
  • Updates the README "Submission process" step to name the master base branch and the .mdx requirement, with a link to the new section.

Closes knowledge-base gap gap-20260930-new-docs-org-pages-pr-branch: "For a new docs.base.org page, which branch in base/docs should a contributor base their PR on, and must new pages be MDX (not Markdown) for the Docs Style / Conformance lint to apply?" (gaps log, DEVREL-859).

Notes to reviewers

Primary sources for each fact:

  • Default branch is master: gh api repos/base/docs --jq .default_branch.
  • Style check covers only changed docs/**/*.mdx: .github/workflows/docs-style-conformance.yml ("Collect changed documentation pages" step, grep -E '^docs/.*\.mdx$').
  • Linter skips non-.mdx paths, docs/snippets/, and .mintignore entries: isLintablePage and NON_PAGE_PREFIXES in scripts/lint-mdx.js.
  • Orphan detection only scans .mdx: scripts/validate-docs-structure.js (orphan detection section).
  • No-argument linter run compares against master and includes uncommitted changes: getChangedFiles in scripts/lint-mdx.js.

The guidance says .mdx is required for lint coverage. It does not say .md pages fail to render.

This replaces the contributor-guidelines/README part of #2087. The security page description fixes in #2087 are not included here.

How has it been tested?

  • node scripts/lint-mdx.js --files-from=<changed list>: passes (no .mdx pages changed).
  • node scripts/validate-docs-structure.js: fails with 2 redirect errors for /upgrades/denim/eip-8130. The same errors appear on unmodified master, so this change didn't cause them.
  • Checked that the external link https://github.com/base/docs returns 200 and that the README anchor #opening-a-pull-request matches the new heading.

Screenshots

N/A (text-only change)

Generated with Toshi

@mintlify

mintlify Bot commented Oct 14, 2026 •

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
base 🟢 Ready View Preview Oct 14, 2026, 7:03 PM

💡 Tip: Enable Automations to automatically generate PRs for you.

@cb-heimdall

Copy link
Copy Markdown
Collaborator

🟡 Heimdall Review Status

Requirement Status More Info
Reviews 🟡 0/1
Denominator calculation
Show calculation
1 if user is bot 0
1 if user is external 0
2 if repo is sensitive 0
From .codeflow.yml 1
Additional review requirements
Show calculation
Max 0
0
From CODEOWNERS 0
Global minimum 0
Max 1
1
1 if commit is unverified 0
Sum 1

@linear

linear Bot commented Oct 14, 2026

Copy link
Copy Markdown

DEVREL-859

This branch was successfully deployed

1 active deployment
staging - docs — 2060aabd Deployed Oct 14, 2026 by mintlify[bot]
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.

2 participants