Skip to content

docs(contributing): update the contributing guide and playground docs - #4826

Merged
thetaPC merged 2 commits into
mainfrom
contributing-route-table
Nov 9, 2026
Merged

thetaPC merged 2 commits into
mainfrom
contributing-route-table

Conversation

@thetaPC

@thetaPC thetaPC commented Nov 4, 2026

Copy link
Copy Markdown
Contributor

Issue URL: internal

What is the current behavior?

The contributing guide and playground docs have drifted from the repo:

  • The route table maps pages to src/pages/*.md, but content lives in docs/ as .mdx
  • The Playground README's multi-file example passes a files prop that does not exist and leaves out version, so copying it renders nothing
  • The generator docs say the playground path defaults to basic, but it has no default
  • CI fails on missing heading IDs and old admonition titles, but the guide mentions neither
  • The guide says the build both works and fails without a GitHub token

What is the new behavior?

CONTRIBUTING.md

  • The route table points at real files, including a v8 row
  • Explains that versions in versions.json are maintained, and that changes to archived version folders never reach the site
  • Notes that JSX paths in older versions need the version prefix, such as /v8/
  • New sections: Checking Links, Heading IDs, Admonitions, and Playgrounds
  • Asks for Conventional Commits PR titles
  • Corrects the GitHub token, Windows, Directories, and Reference Content sections

Playground docs

  • Playground README: working examples, an options table, and how to add StackBlitz dependencies
  • Template README: lists the generator's four prompts

Does this introduce a breaking change?

  • Yes
  • No

Other information

N/A

@vercel

vercel Bot commented Nov 4, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
ionic-docs Ready Ready Preview Nov 4, 2026 10:59pm UTC

Request Review

@thetaPC
thetaPC marked this pull request as ready for review November 4, 2026 23:15
@thetaPC
thetaPC requested a review from a team as a code owner November 4, 2026 23:15
@thetaPC
thetaPC requested a review from brandyscarney November 4, 2026 23:15

@OS-jacobbell OS-jacobbell left a comment

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.

LGTM

@thetaPC
thetaPC merged commit 7eefd7b into main Nov 9, 2026
7 checks passed
@thetaPC
thetaPC deleted the contributing-route-table branch November 9, 2026 22:32

This branch was successfully deployed

1 active deployment
Preview — 58e32560 Deployed Nov 4, 2026 by vercel[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