-
Notifications
You must be signed in to change notification settings - Fork 38
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Description
repo sanitization
- assess the structure of the repo to:
- include
docstringstyle documentation for all models, utils - include style guidelines, automated tests for linting
- include
- include git conventions, branch creation strategies, recommended good practices for contribution
- include
ISSUE_TEMPLATE, and guidelines for creating PR's to contributors
docs and auto-deployment
- modify the
READMEto provide higher level idea, description, and example script to get started - include necessary documentation resources within
READMEand point to the docs site for elaborate usage/explanations ofHydraGNN - mention about
HPCcomponent of runningHydraGNNon exascale compute clusters likeFrontier, etc. - test the feasibility of either using
pdoc3orreadthedocsto ensure documentation of the website is automatically pushed to a connected web endpoint
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation