Skip to content

Latest commit

 

History

History
9 lines (7 loc) · 732 Bytes

README.md

File metadata and controls

9 lines (7 loc) · 732 Bytes
Raw

Unity Pomodoro Documentation

https://adrian-miasik.github.io/unity-pomodoro-docs/

How to generate & publish the most up-to-date docs

  1. Update the unity-pomodoro submodule using command: git submodule update --remote --merge.
  2. Navigate into the .\docfx_project\ directory.
  3. Run command docfx to build the latest docs. If you'd like to preview the docs locally run this command with the --serve option as such: docfx --serve. You will be able to preview the docs via local host, see console output.
  4. Stage and push your updated submodule and docs folder to git. (Ideally follow gitflow, only changes to the \master get uploaded to our site via GitHub pages)