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

Repository sanitization and pathway for automatic deployment of docs #236

Open
akhilpandey95 opened this issue Apr 9, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@akhilpandey95
Copy link
Collaborator

repo sanitization

  • assess the structure of the repo to:
    • include docstring style documentation for all models, utils
    • include style guidelines, automated tests for linting
  • 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 README to provide higher level idea, description, and example script to get started
  • include necessary documentation resources within README and point to the docs site for elaborate usage/explanations of HydraGNN
  • mention about HPC component of running HydraGNN on exascale compute clusters like Frontier, etc.
  • test the feasibility of either using pdoc3 or readthedocs to ensure documentation of the website is automatically pushed to a connected web endpoint
@allaffa allaffa added the documentation Improvements or additions to documentation label Apr 11, 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