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

Meeko Documentation #135

Open
psharma-sr opened this issue Jun 20, 2024 · 0 comments
Open

Meeko Documentation #135

psharma-sr opened this issue Jun 20, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@psharma-sr
Copy link
Contributor

psharma-sr commented Jun 20, 2024

Following additional changes to Meeko, make sure that basic usage procedures are updated and accessible in some form of documentation. This needs more discussion, but some specific points that should be included in documentation are as follows:

  • An overview of the classes and functions of Meeko.
  • Descriptions of what data files are, especially ones that are considered default or that people will be directly relying upon as inputs.
@psharma-sr psharma-sr added the documentation Improvements or additions to documentation label Jun 20, 2024
@psharma-sr psharma-sr added this to the Meeko Refactoring Project milestone Jun 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants