Skip to content

mdyd-dev/platformos-documentation

Repository files navigation

Tested by CodeceptJS

Contribute content

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

  1. Fork the repository.
  2. Install node.js dependencies (npm).
  3. 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.
  4. Create a pull request.
  5. We review your changes, and either get back to you with our feedback, or merge your changes.

Contributors

Thank you to all our contributors!


Diana Lakatos

๐Ÿ“–

Paweล‚ Kowalski

๐Ÿ“– ๐Ÿ’ป โš ๏ธ

Maciej Krajowski-Kukiel

๐Ÿ“–

Ryan Stephen

๐Ÿ“–

piotrze

๐Ÿ“–

Tomek

๐Ÿ“–

Krzysztof Danek

๐Ÿ“–

dariusz gorzeba

๐Ÿ“–

Ignacy Moryc

๐Ÿ“–

Daniel Telfer

๐Ÿ“–

Istvรกn Zoltรกn Szabรณ

๐Ÿ“–

Kacper Walanus

๐Ÿ“–

Kornel Lugosi

๐Ÿ“–

Dean Vizer

๐Ÿ“–

kata-ngy

๐Ÿ“–

Adam Cook

๐Ÿ“–

JJ Bragg

๐Ÿ“–

Jakub Augustyn

๐Ÿ“–

turing9783

๐Ÿ“–

Julien Levadoux

๐Ÿ“–

Krzysztof Streflik

๐Ÿ“–

Ryan Johnson

๐Ÿ“–

power833

๐Ÿ“–

Daryl Barnes

๐Ÿ“–

Developer-DNM

๐Ÿ“–

Maciej Wฤ™grzynek

๐Ÿ“–

Kรกlmรกn Hosszu

๐Ÿ–‹ ๐Ÿ’ก

Scott B Reynolds

๐Ÿ–‹

Antony Siegert

๐Ÿ–‹

ลukasz Krysiewicz

๐Ÿ–‹

andrew-3

๐Ÿ“–

Josh Carter

๐Ÿ“–

Contribute code

Required global dependencies

  • nodejs 12.10 and above
  • npm 6.1 and above

Development

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