Skip to content

[Docs] Improve JobShopGraph documentation #80

@Pabloo22

Description

@Pabloo22

I think it is important for users to understand how this class works, especially for those interested in using our Gymnasium environments.

First, it should give an overview of the class and explain its purpose. Then, it should explain what nodes and edges can represent, as well as some useful methods, etc. In short, everything you need to understand the class quickly without having to read the code.

We also need a tutorial (see the SA one for an example) to show usage examples and go into more details.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions