Skip to content
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

Documentation Issues #248

Closed
Ulvetanna opened this issue Feb 12, 2024 · 1 comment · Fixed by #251
Closed

Documentation Issues #248

Ulvetanna opened this issue Feb 12, 2024 · 1 comment · Fixed by #251
Labels
Bug It might be considered a bug...

Comments

@Ulvetanna
Copy link
Collaborator

Ulvetanna commented Feb 12, 2024

Description
The documentation currently still needs a lot of work.

The Examples of running code example in the repo is un-populated. All un-populated pages should be removed. Once we have finalised we can give to member of the group not working on this aspect of the project to check if they can get an example running without help.

As most people looking at the software will only spend 1-2 mins to try and get it working this means that the welcome page should show a very simple example. I would suggest a link to recreate a full route-planning example using Colab (Then they shouldn't need to install the Python Package.
In addition, all your example meshes in the Github codebase are not visible for people on PyPI so we need to include these examples on a shared drive (one drive), so that the user can install and run the example directly from Docs and PyPI without having to install Github Repo.

There is currently issues for @foxm1 for building the software from sphinx with the differences between the built manual showing empty Vessel Performance doc-strings relative to the Github IO Manual

@Ulvetanna Ulvetanna added the Bug It might be considered a bug... label Feb 12, 2024
@gecoombs gecoombs mentioned this issue Feb 19, 2024
6 tasks
@gecoombs gecoombs linked a pull request Feb 21, 2024 that will close this issue
6 tasks
@gecoombs
Copy link
Member

Empty sections of the docs have been removed and the text has been updated to reflect all recent changes to the code. Issues with examples and installation instructions have been addressed as part of #249 and #250.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug It might be considered a bug...
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants