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

user manual #890

Open
dave-doty opened this issue Jul 22, 2023 · 0 comments
Open

user manual #890

dave-doty opened this issue Jul 22, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation high priority Something cruicial to get working soon.

Comments

@dave-doty
Copy link
Member

Currently, the main features of scadnano are documented in the README, and several features that have been added since that was updated are scattered across GitHub release notes.

Create a user manual that documents all features, and add a section to the CONTRIBUTING document that requires the manual to be updated whenever a new feature is added via a PR.
@dave-doty dave-doty added documentation Improvements or additions to documentation high priority Something cruicial to get working soon. labels Jul 22, 2023
@dave-doty dave-doty changed the title create user manual user manual Jul 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation high priority Something cruicial to get working soon.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@dave-doty