Xbox One Research wiki

Various info regarding the hard-/software of the Xbox One gaming console family.

Python framework mkdocs is used to render the Markdown documentation.

Contribute

Contributions are very welcome. Here's how you can help:

• Add / correct / expand technical information
• Improve documentation style
• Correct spelling / grammar
• Check ISSUES tab...

Workflow

1. Fork this repo
2. Make changes
3. Verify your changes are formatted properly
4. Send a Pull Request

Local testing

1. Clone your fork of the wiki (Change 'yourusername' accordingly)

git clone [email protected]:yourusername/wiki.git

2. Navigate into wiki repository folder

cd wiki/

3. 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

4. Install mkdocs and dependencies

pip install -r requirements.txt

5. Edit docs and verify with the following commands:

Serve the documentation

make serve

Build the documentation

make build --strict

6. Commit & push your changes
7. Send a Pull Request