WordPress Playground’s documentation site is maintained by volunteers like you, who’d love your help.
All documentation-related issues are labeled [Type] Documentation or [Type] Developer Documentation in the WordPress/wordpress-playground repository. Browse the list of open issues to find one you’d like to work on. Alternatively, if you believe something is missing from the current documentation, open an issue to discuss your suggestion.
How can I contribute?
You can contribute by opening an issue in the project repository and describing what you’d like to add or change.
If you feel up to it, write the content in the issue description, and the project contributors will take care of the rest.
Would you like to see the documentation in your language? Check the Translation section.
If you want to make a small documentation change without setting up a local development environment, see Contribute with the GitHub web interface.
Forking the repo, edit files locally and opening Pull Requests
If you are familiar with markdown, you can fork the wordpress-playground repo and propose changes and new documentation pages by submitting a Pull Request.
The process of creating a branch to open new PRs with translated pages on the WordPress/wordpress-playground repository is the same as contributing to other WordPress repositories such as Gutenberg:
The documentation files (.md files) are stored in Playground’s GitHub repository, under /packages/docs/site/docs for English and /packages/docs/site/i18n for other languages.
Edit in the browser
You can edit existing files or add new documentation pages directly from the GitHub website. This approach does not require Git, a terminal, or a local development environment.
For the full step-by-step workflow, see Contribute with the GitHub web interface.
Local preview
Clone the repository and navigate to the directory on your device. Now run the following commands:
npm install
npm run build:docs
npm run dev:docs
The documentation site opens in a new browser tab and refreshes automatically with each change. Continue to edit the relevant file in your code editor and test the changes in real-time.