Thank you for your interest in contributing to the platformOS documentation! Our docs are a tool for our community, so we strive to ensure they serve you well. We always welcome any kind of contribution to our documentation: we value your feedback, and appreciate any improvement suggestions or extensions.
Give us feedback
Create an issue with your finding in the Issues tab.
Edit or add topics on the GitHub UI
Go to the file you would like to change, click edit and commit changes on the GitHub UI.
Edit or add topics using git
- Fork the repository.
- Install node.js dependencies (npm).
- Change something or add a new topic. Please check if a template is already available for the type of content you’d like to contribute. We have prepared templates for most content on our documentation page, to make contribution easier, and to ensure the consistency of contributed content. Please make sure to follow our style guide.
- Create a pull request.
- We review your changes, and either get back to you with our feedback, or merge your changes.
Thank you to all our contributors!
Required global dependencies
- nodejs 12.10 and above
- npm 6.1 and above
npm ci # installs local dependencies npm start # runs webpack in watch mode, pos-cli sync with livereload
Build production assets
npm run build # runs webpack in production mode