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.

Sign up for GitHub

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

Jump to bottom

[#29] Add project documentation #33

Merged
merged 19 commits into from
Feb 11, 2025
Merged

[#29] Add project documentation #33

merged 19 commits into from
Feb 11, 2025

Conversation

SonnyBA
Copy link
Contributor

@SonnyBA SonnyBA commented Jan 24, 2025

Fixes #29

Changes

Adds a changelog and RTD documentation

@SonnyBA SonnyBA force-pushed the issue/#29-add-project-documentation branch from e8a460c to 485ed08 Compare January 24, 2025 15:26
SonnyBA
SonnyBA commented Jan 29, 2025
View reviewed changes
SECURITY.md Outdated Show resolved Hide resolved
docker-compose.yml Outdated Show resolved Hide resolved
docs/client-development/recipes.rst Show resolved Hide resolved
docs/conf.py Show resolved Hide resolved
docs/development/getting_started.rst Show resolved Hide resolved
@SonnyBA SonnyBA force-pushed the issue/#29-add-project-documentation branch from 233b206 to 6d66586 Compare January 29, 2025 09:47
@SonnyBA SonnyBA self-assigned this Jan 29, 2025
@SonnyBA SonnyBA marked this pull request as ready for review January 29, 2025 09:54
@SonnyBA SonnyBA requested a review from Floris272 January 29, 2025 09:54
Floris272
Floris272 approved these changes Feb 3, 2025
View reviewed changes
Copy link
Contributor

@Floris272 Floris272 left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Look good!

found two minor things, and i added an image to the readme in #38 which may need to be moved to a different folder in /docs?

Also what do i need to do to host the docs so that it can be linked in the readme?

LICENSE.md Outdated Show resolved Hide resolved
docs/installation/config/env_config.rst Outdated Show resolved Hide resolved
@SonnyBA SonnyBA force-pushed the issue/#29-add-project-documentation branch from 6d66586 to 0d73a1f Compare February 11, 2025 09:20
@SonnyBA
Copy link
Contributor Author

SonnyBA commented Feb 11, 2025

Look good!

found two minor things, and i added an image to the readme in #38 which may need to be moved to a different folder in /docs?

Also what do i need to do to host the docs so that it can be linked in the readme?

Regarding the last question, once this PR is merged, we should be able to follow these steps.

@SonnyBA SonnyBA requested a review from Floris272 February 11, 2025 10:05
Floris272
Floris272 requested changes Feb 11, 2025
View reviewed changes
docs/client-development/cors.rst Outdated Show resolved Hide resolved
docs/installation/provision_superuser.rst Outdated Show resolved Hide resolved
docs/manual/general.rst Outdated Show resolved Hide resolved
docs/manual/general.rst Outdated Show resolved Hide resolved
docs/manual/general.rst Outdated Show resolved Hide resolved
docs/manual/general.rst Outdated Show resolved Hide resolved
docs/manual/general.rst Outdated Show resolved Hide resolved
@SonnyBA SonnyBA force-pushed the issue/#29-add-project-documentation branch from a513c6c to 38385ad Compare February 11, 2025 13:20
@SonnyBA
[#29] revert docker changes
eec5a4b 
Will be added through an separate PR
@SonnyBA SonnyBA requested a review from Floris272 February 11, 2025 13:28
@SonnyBA SonnyBA merged commit 719319a into master Feb 11, 2025
18 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Floris272 Floris272 Floris272 approved these changes

Assignees

@SonnyBA SonnyBA

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Validate and/or extend the documentation
2 participants
@SonnyBA @Floris272