theporgs / exegol-docs

Documentation for Exegol

📌 This repository hosts code for the Exegol documentation, a sub-repository of the Exegol project. If you were looking for Exegol, go to the main repo

---

Exegol docs

This repository hosts the source of the documentation for users, contributors, developers (work in progress), and maintainers (work in progress).

Link to the doc: https://exegol.readthedocs.io/.

Branch description

• main: The main branch is the officiel latest stable version of the exegol project.
• dev: The dev branch is a place for updates related to existing features and minor documentation updates.
• dev-images: This branch is dedicated to the latest news being developed in exegol image (nightly). It will be merge in "main" when a stable and official version will be released.
• dev-wrapper: this branch is dedicated to the latest news being developed in exegol wrapper (dev). It will be merge in "main" when a stable and official version will be released.

exegol-docs's Issues

Exegol-images#181

PR ThePorgs/Exegol-images#181, by @gbe, needs to be documented

Maintainers documentation

Explain all pipeline information, how to set up runners, etc.

CI/CD pipeline (docs)

Contributors documentation

Have the code documented dynamically through its comments and structure, and document how contributors can help out

List of tools

We need to document the tools installed in exegol. In my opinion, it should end up in the Exegol images section.

User documentation

Extra word

On the my-resources page, I found a sentence contains an extra verb:
"Custom tools: users can store add their own custom standalone tools".
The issue is also present on the branch dev-images.

Seems like the author was hesitating between store and add, or there is a missing slash character ;)
I personnally like place, but I leave it up to you to settle on one.

Add FAQ section

We should add a Frequently Asked Questions section in the doc

Add warning about Python installation on Windows

Description

Following the documentation, python3 command is not working on Windows and prevents the installation of Exegol.

The Windows Python full installer only allows the following commands:

• py : the Python Launcher will start the latest version of Python installed
• python: only available if the following option is checked during install Add python.exe to PATH

The Microsoft Store package must be installed in order to make the python3 command available.

Action

• Add a warning in the documentation for Windows users
• Update the link to the latest Python Microsoft Store package https://apps.microsoft.com/store/detail/python-311/9NRWMJP3717K