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

Improve installation and usage documentation #1005

Closed
dsalaza4 opened this issue Feb 16, 2023 · 0 comments
Closed

Improve installation and usage documentation #1005

dsalaza4 opened this issue Feb 16, 2023 · 0 comments
Assignees
@dsalaza4

Comments

@dsalaza4
Copy link
Contributor

dsalaza4 commented Feb 16, 2023 •
edited
Loading

We currently split installation and usage documentation into 3 items:

  1. Getting started
  2. Getting started as a final user
  3. Getting starter as a developer

This looks unnecessarily complex, maybe we should change it to

  1. Installation
  2. Usage

Let's make it as simple and possible and let users figure out creative ways of exploiting the tool's potential.
@dsalaza4 dsalaza4 self-assigned this Mar 7, 2023
dsalaza4 added a commit that referenced this issue Mar 7, 2023
@dsalaza4
Merge pull request #1016 from dsalaza4/main
2cbdd47 
feat(doc): #1005 improve doc
github-actions bot added a commit that referenced this issue Mar 7, 2023
@github-actions
Merge pull request #1016 from dsalaza4/main
3024154 
feat(doc): #1005 improve doc
dsalaza4 added a commit that referenced this issue Mar 8, 2023
@dsalaza4
Merge pull request #1017 from dsalaza4/main
b5576a8 
feat(doc): #1005 simpler doc
@dsalaza4 dsalaza4 closed this as completed Mar 8, 2023
github-actions bot added a commit that referenced this issue Mar 8, 2023
@github-actions
Merge pull request #1017 from dsalaza4/main
9926499 
feat(doc): #1005 simpler doc
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@dsalaza4 dsalaza4

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@dsalaza4