829 Developer Documentation

This site serves as a central repository for documenting processes and standards for the 829 Studios Dev Teams.

The framework for this site is built on MkDocs and uses markdown files to compose pages. For full documentation visit mkdocs.org.

MkDocs utilizes both Python and pip. You can check to see that these are installed on your workstation by checking the version number via the terminal:

$ python --version
Python 3.8.2
$ pip --version
pip 20.0.2 from /usr/local/lib/python3.8/site-packages/pip (python 3.8)

Assuming you have both, install the MkDocs core and the necessary plugins for this project:

$ pip install mkdocs
$ pip install mkdocs-encryptcontent-plugin
$ pip install mkdocs-awesome-pages-plugin

The source for the site is managed via git at https://bitbucket.org/829studios/829-developer-documentation. Documents are created using Markdown syntax.

To submit new documention or make edits to existing documentation, please follow 829 git workflow standards and create a branch containing your changes. Make a pull request into the main branch and your submission will be reviewed for addition.

Once the dependencies are all installed, you're ready to start making edits and improvements to the documentation. Use the following commands to work with MkDocs:

MkDocs Commands

• mkdocs new [dir-name] - Create a new project.
• mkdocs serve - Start the live-reloading docs server.
• mkdocs build - Build the documentation site.

Project layout

mkdocs.yml    # The configuration file.
docs/
    index.md  # The documentation homepage.
    ...       # Other markdown pages, images and other files.