Welcome to PMC Docs
PMC Docs offers a standardized and fully owned+operated middleware to facilitate extracting documentation from repos and other sources.
Start here to learn how to contribute to the docs.
This repo should be considered for documentation that should exist in a repo but doesn't have a clear home. For example, coding standards.
Example usage
- Pull in documentation from markdown across our repos into a single location.
- Automate documentation from docblocks and inline comments in PHP and JS files.
- Serve as a location for docs we want version controlled (coding standards), but don't necessarily have their own repo.
- [Roadmap] Extract data via CLI from our brands. Render that data as "real"-time. I.e. what plugins are running on all brands?
What is it?
This is a next.js (opens in a new tab) instance using nextra (opens in a new tab).
The repo is at pmc-docs (opens in a new tab) and deploys to GitHub Pages (opens in a new tab).
Auth to pmc-docs is controlled by GitHub. If you don't have permission to see the repo, you don't have permission to see this.
[Work in Progress] Confluence sync
When pmc-docs builds, we also sync to a Confluence space to ensure everyone at PMC
https://penskemedia.atlassian.net/wiki/spaces/PED/overview (opens in a new tab)