Various info regarding the hard-/software of the Xbox One gaming console family.
Python framework mkdocs is used to render the Markdown documentation.
Contributions are very welcome. Here's how you can help:
- Add / correct / expand technical information
- Improve documentation style
- Correct spelling / grammar
- Check ISSUES tab...
- Fork this repo
- Make changes
- Verify your changes are formatted properly (otherwise the PR cannot be accepted)
- Send a Pull Request
NOTE: When adding a new page, ensure it's linked in NAVIGATION.md
- Clone your fork of the wiki (Change 'yourusername' accordingly)
git clone git@github.com:yourusername/wiki.git
- Navigate into wiki repository folder
cd wiki/
- Choose one of the two deployment methods below.
- Create & activate python virtual-environment (might need dependency
python3-venv, see: https://docs.python.org/3/library/venv.html)
python3 -m venv venv
source venv/bin/activate
- Install mkdocs and dependencies
pip install -r requirements.txt
- Edit docs and verify with the following commands:
Serve the documentation (http://127.0.0.1:8000)
mkdocs serve --strict
Build the documentation
mkdocs build --strict
- Execute docker container:
docker compose up
- Navigate to http://127.0.0.1:8000
- Make your changes and verify the formatting / linking still checks out.