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.

Sign up for GitHub

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

Jump to bottom

Rewrite/improve Emma top level documentation #91

Open
holzkohlengrill opened this issue Jan 25, 2021 · 0 comments
Open

Rewrite/improve Emma top level documentation #91

holzkohlengrill opened this issue Jan 25, 2021 · 0 comments
Assignees
@holzkohlengrill @KGergo88 @DariaPigasova
Labels
documentation Improvements/additions to documentation & documenting issues (-> meaning no actual work was done) enhancement New feature or request good first issue Good for newcomers SP: 8
Projects
Planning

Comments

@holzkohlengrill
Copy link
Collaborator

Feature Description

In order get a more gentle introduction and better presentation of Emma a rework of the top level (README.md) readme would be beneficial.

  • Some parts are too technical and should be moved to the in-depth/formal documentation part of Emma
  • The introduction is to hard to read and some text passages are too long

Our recent email to the GENIVI projects mailing list could be a good starting point.
@holzkohlengrill holzkohlengrill added documentation Improvements/additions to documentation & documenting issues (-> meaning no actual work was done) enhancement New feature or request good first issue Good for newcomers SP: 8 labels Jan 25, 2021
@holzkohlengrill holzkohlengrill added this to Backlog in Planning via automation Jan 25, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@holzkohlengrill holzkohlengrill

@KGergo88 KGergo88

@DariaPigasova DariaPigasova

Labels
documentation Improvements/additions to documentation & documenting issues (-> meaning no actual work was done) enhancement New feature or request good first issue Good for newcomers SP: 8
Projects
Planning
  
Backlog
Milestone
No milestone
Development

No branches or pull requests
3 participants
@holzkohlengrill @KGergo88 @DariaPigasova