CONTRIBUTING.md

Contributing to the documentation

The Markdown files in this repository are the source of truth for the Inlay documentation site. The generated docs-site/dist/ directory is not edited by hand.

For package, API, or implementation changes, contribute to the main Inlay repository instead:

https://github.com/InlayPHP/inlay/blob/main/CONTRIBUTING.md

Documentation workflow

1. Edit a source file under docs/ or a package README.md.
2. Run npm run build --prefix docs-site.
3. Check internal links, code examples, and responsive layout locally.
4. Open a focused pull request describing the audience and purpose of the documentation change.

Start the local server with:

npm run dev --prefix docs-site

The site is deployed by GitHub Actions after approved changes land on main.