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

Update/enhance documentation #36

Open
hansb001 opened this issue Jul 18, 2022 · 5 comments
Open

Update/enhance documentation #36

hansb001 opened this issue Jul 18, 2022 · 5 comments
Assignees
Labels
community continuous worked on documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed high priority Quality Quality enhancement needed
Milestone

Comments

@hansb001
Copy link
Contributor

Based on discussions in Dusseldorf, we must review the existing documentation.

  • The structure is not always clear
  • hard to find topics
  • not always updated to latest versions
  • missing parts
@hansb001
Copy link
Contributor Author

see also: thin-edge/thin-edge.io#1238. Detailed steps to take, will be added in community issues:

@hansb001
Copy link
Contributor Author

hansb001 commented Jul 18, 2022

Almost all content is available, but needs to be checked if still current and reorganized in the following way:
also directly in github, people will look first there and they will later click on the link to the documentation.

Requirements/prereq guide

Detailed installation guide

Detailed configuration guide

Detailed developer guide, how to extend.

Contribution guide

Getting started guide, like hello world

How to guides and tutorials need to be combined, no difference

Other points of attention:

Website gif (installation) has to be updated

Less text, more images. Images helped with attractiveness and with searching for specific menu options etc.

@hansb001
Copy link
Contributor Author

@hansb001
Copy link
Contributor Author

hansb001 commented Nov 1, 2022

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
community continuous worked on documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed high priority Quality Quality enhancement needed
Projects
Community Board
  
In progress
Development

No branches or pull requests

4 participants