Xbox One Research Wiki

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

Python framework properdocs 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 the "Issues" tab…

1. Fork this repo

2. Make changes

3. Verify your changes are formatted properly (otherwise the PR cannot be accepted)

4. Send a Pull Request

1. At first: Fork the repository to your account!

2. Clone your fork of the wiki (Change 'YourUsername' accordingly):

   # SSH
   git clone git@github.com:YourUsername/wiki.git
   
   or
   
   # HTTPS
   git clone https://github.com/YourUsername/wiki.git

3. Navigate into wiki repository folder

   cd wiki/

4. Choose one of the two deployment methods below and follow thier instructions:

Native or Docker

5. At this point, load up the cloned repository in a text editor that has live-markdown preview function.

• For example: Visual Studio Code. Instructions: (https://code.visualstudio.com/Docs/languages/markdown)

6. Once you are happy and the added changes are looking proper, you are ready to submit your work.

Add modified files for commiting

git add docs/<edited_file>.md
git add docs/<edited_file_2>.md
...

Create a new commit

git commit

# Now in the upcoming editor, describe the changes you made.

Push the changes to your forked repository

git push

8. Send a Pull Request :)

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

2. Install properdocs, and its dependencies:

   pip install -r requirements.txt

3. Edit docs and verify with the following commands:

   1. Serve the documentation (http://127.0.0.1:8000):

      properdocs serve --strict

   2. Build the documentation:

      properdocs build --strict

1. Execute docker container:

   docker compose up --build --force-recreate

2. Navigate to http://127.0.0.1:8000.

3. Make your changes, then verify the formatting / linking still checks out.