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

Change documentation startup page #12

Open
RichardPfr opened this issue May 22, 2024 · 0 comments
Open

Change documentation startup page #12

RichardPfr opened this issue May 22, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@RichardPfr
Copy link

The information currently presented on the startup page is all correct and useful but might overwhelm people that are trying to get into PyRolL. Also the description of how to install PyRolL should be further up.

The startup page should rather have the following order:

  1. what can you do with PyRolL
    • maybe in the form of a short GiF or Video
    • additionally a button to try it out (link to the examples on binder)
  2. How to install PyRolL
    • button with a link or a fold-out of that page
  3. Getting started with PyRolL
    • button with a link or a fold-out of that page
  4. ... (here the further explanations like currently can be given)

Further ideas and suggestions regarding the startuppage may be collected here.

PS: @mxstrl Is this equivalent to the order you wrote down or imagined?

@RichardPfr RichardPfr added enhancement New feature or request documentation Improvements or additions to documentation labels May 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants