Documentation - Githubissues

ImperialCollegeLondon / SupraShare

Platform for sharing trained ML models for chemistry

BSD 3-Clause "New" or "Revised" License

4 stars 0 forks source link

Documentation #9

Open dandavies99 opened 2 years ago

dandavies99 commented 2 years ago

Add documentation for how to use this template to add a new app to the web server, including:

[ ] Info on the overall directory structure
[ ] Use of feature, develop and main branches
[ ] Modifying the Docker environment
[ ] Adding tests
[ ] Modifying GitHub Actions (QA, tests and deployment)
[ ] Testing locally with docker-compose
[ ] Adding the final image to the web server

AdrianDAlessandro commented 2 years ago

Not sure if you're planning proper API documentation, but the docstrings for all the Dash functions contain information on how they're intended to be used, which can easily be converted into documentation. They could/should be expanded, and maybe some examples/doctests would be a good idea.

AdrianDAlessandro commented 2 years ago

Some notes from building the cage-prediction-webapp using this template:

Only include develop branch when creating new repo because unrelated histories complicates creating pull requests. Instead suggest git checkout -b main and git push -u origin main to publish
Make the image public https://docs.github.com/en/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility#configuring-visibility-of-container-images-for-your-personal-account
Image for example of creating template: