-
- Downloads
Documentation overhaul - Fixing formatting issues, autodoc implementation, and...
Documentation overhaul - Fixing formatting issues, autodoc implementation, and added variables for versions. (#3734) Closes #3639. This is a bit of an overhaul of the docs to make them more easy to utilize. This changes include: - Removal of overhanging public aspects of the documentation - Reformatting of terminal commands to allow for easy copy & pasting - Updating points of contact - Screenshot Updates - Automated code API documentation. [Google's docstring style](https://github.com/google/styleguide/blob/gh-pages/pyguide.md#38-comments-and-docstrings) should be used. - Added variables for things like software versions & packages. - Unless python & node version are manually specified, when docs are built these will be pulled from [`.nvmrc`](https://github.com/HyphaApp/hypha/blob/main/.nvmrc) & [`.python-version`](https://github.com/HyphaApp/hypha/blob/main/.python-version) - Consolidated the production and development guides into one location (both under `Setup` rather than one under `Getting Started` and one under `Setup`), and updated them to be similar to one another. - Added different steps for getting Hypha development deployed under multiple OSs
Showing
- .github/workflows/deploy-docs.yml 1 addition, 0 deletions.github/workflows/deploy-docs.yml
- CODE_OF_CONDUCT.md 1 addition, 1 deletionCODE_OF_CONDUCT.md
- README.md 2 additions, 2 deletionsREADME.md
- SECURITY.md 1 addition, 1 deletionSECURITY.md
- docker/entrypoint.dev.sh 1 addition, 1 deletiondocker/entrypoint.dev.sh
- docs/assets/how-to-login-login-page.png 0 additions, 0 deletionsdocs/assets/how-to-login-login-page.png
- docs/assets/how-to-login-nav.png 0 additions, 0 deletionsdocs/assets/how-to-login-nav.png
- docs/assets/how-to-login-w-pass-btn.png 0 additions, 0 deletionsdocs/assets/how-to-login-w-pass-btn.png
- docs/assets/how-to-login-w-pass-prompt.png 0 additions, 0 deletionsdocs/assets/how-to-login-w-pass-prompt.png
- docs/assets/how-to-login-wo-pw-page.png 0 additions, 0 deletionsdocs/assets/how-to-login-wo-pw-page.png
- docs/getting-started/architecture.md 26 additions, 13 deletionsdocs/getting-started/architecture.md
- docs/getting-started/contributing/code-contributions.md 1 addition, 1 deletiondocs/getting-started/contributing/code-contributions.md
- docs/getting-started/contributing/submitting-changes.md 17 additions, 17 deletionsdocs/getting-started/contributing/submitting-changes.md
- docs/getting-started/deployment.md 3 additions, 0 deletionsdocs/getting-started/deployment.md
- docs/index.md 1 addition, 1 deletiondocs/index.md
- docs/scripts/doc_macros.py 101 additions, 0 deletionsdocs/scripts/doc_macros.py
- docs/scripts/gen_ref_pages.py 52 additions, 0 deletionsdocs/scripts/gen_ref_pages.py
- docs/setup/administrators/configuration.md 118 additions, 54 deletionsdocs/setup/administrators/configuration.md
- docs/setup/administrators/setup-email.md 0 additions, 32 deletionsdocs/setup/administrators/setup-email.md
- docs/setup/administrators/setup-notifications.md 11 additions, 0 deletionsdocs/setup/administrators/setup-notifications.md
Loading
Please register or sign in to comment