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

Add documentation in the interface or a link to a separate page #42

Closed
kensei-te opened this issue Mar 18, 2022 · 4 comments
Closed

Add documentation in the interface or a link to a separate page #42

kensei-te opened this issue Mar 18, 2022 · 4 comments
Assignees
Labels
documentation Improvements or additions to documentation medium

Comments

@kensei-te
Copy link
Collaborator

As you demanded my comment on interface... although I am more comfortable to say this kind of stuff face-to-face

Can you have "explanation" for each item? it can be either link to separate page or can be in the bottom or top of the page

kensei

@lfoppiano
Copy link
Owner

Thanks @ktkktkt, you mean documentation on the home page or on the table view?

@kensei-te
Copy link
Collaborator Author

@lfoppiano
yes, something like that.

@lfoppiano lfoppiano changed the title "About" or help pop-up Add documentation in the interface or a link to a separate page Mar 18, 2022
@lfoppiano
Copy link
Owner

OK. I think the best is to create a documentation that is deployed on readthemanual.io, something like supercon2.readthemanual.io. Users can open it from the interface and the documentation will provide description of all the fields and how to use the interface itself.

@lfoppiano lfoppiano added documentation Improvements or additions to documentation medium labels Mar 18, 2022
@lfoppiano
Copy link
Owner

lfoppiano commented Mar 23, 2022

I added a link to the documentation from the homepage and I started working on it.

You can see the WIP here: https://github.com/lfoppiano/supercon2/blob/develop/README.md

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 medium
Projects
None yet
Development

No branches or pull requests

2 participants