-
Notifications
You must be signed in to change notification settings - Fork 100
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
The documentation is scattered #324
Comments
Agreed. I think we could improve this a lot! I think #290 would help this a lot, but I am not sure how to evaluate all of the difficulties that would come with that. Regardless of the answer to the above question, I like the idea of putting more in the POMDPs.jl documentation. Now, with better Documenter doctests, I thing we should move the things from POMDPExamples into it. The concepts here are helpful for organization: https://www.writethedocs.org/videos/eu/2017/the-four-kinds-of-documentation-and-why-you-need-to-understand-what-they-are-daniele-procida/ Reference docs should probably be as near to the code as possible, but tutorials and explanations should probably go in a central place. |
It would definitely make sense to have a tutorial section where we could put all the examples. The docs folder can have a separate Project.toml so it might be ok to have some dependencies on the solvers in there. |
Definitely agree with @MaximeBouton. For example, the defining (PO)MDPs could use some minor restructuring. It would be helpful to provide and overview at the beginning before delving into each one: But overall, Julia POMDPs is great! |
Even if the ecosystem is split into multiple packages I think the documentation should be centralized.
It is often hard for newcomers to discover all the packages of the ecosystem.
Examples:
Maybe the main POMDPs.jl page should have a section on the whole ecosystem linking to all the other documentations pages.
The text was updated successfully, but these errors were encountered: