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

Restructure documentation #41

Open
jmgate opened this issue Apr 25, 2024 · 0 comments
Open

Restructure documentation #41

jmgate opened this issue Apr 25, 2024 · 0 comments
Labels
Type: Documentation Pertaining to the documentation of the package.

Comments

@jmgate
Copy link
Collaborator

jmgate commented Apr 25, 2024

INSERT DETAILS HERE.

It'll be worthwhile to restructure the documentation such that it has separate sections for users and developers. That way all the user needs to know is how to get up and running with it, but if you're going to be hacking on the repository, there's more information available to you.

  • What would you like to see in the documentation?
  • How does our current documentation not meet your needs?
  • How has this lack of documentation affected you?
  • What are you trying to accomplish?
@jmgate jmgate added the Type: Documentation Pertaining to the documentation of the package. label Apr 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Type: Documentation Pertaining to the documentation of the package.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@jmgate