Updating Documentation
Our documentation uses JetBrains Writerside and lives at https://freemocap.github.io/documentation/.
PyCharm can be installed and updated using JetBrains Toolbox.
These instructions ensure a reliable workflow using that specific toolset.
Because our documentation builds from a GitHub Actions that triggers from every commit, we require pull requests for all changes.
If you ARE NOT a member of the FreeMoCap organization
In PyCharm, install the Writerside plugin, restart PyCharm, then select the Writerside plugin in the left toolbar.
Fork the repository and clone the forked repository's URL.
URL: https://github.com/[YOUR USERNAME]/documentation/
Use the Writerside formatting style guide: Markdown vs semantic markup - Writerside Documentation
Once you've finished making your updates to documentation, submit a PR onto
main.
If you ARE a member of the FreeMoCap organization
In PyCharm, install the Writerside plugin, restart PyCharm, then select the Writerside plugin in the left toolbar.
Select
Git→Clonefrom the top menu.Create a branch.
This can be done in PyCharm by clicking
mainin the top left and selecting+ New Branch.
Use the Writerside formatting style guide: Markdown vs semantic markup - Writerside Documentation
Once you've finished making your updates to documentation, submit a PR onto
main.