docs: enhance sponsorship uc documentation #1928
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
JacobCoffee
reviewed
Sep 12, 2024
| @@ -106,6 +106,13 @@ they represent: | |||
| :contract.py: The `Contract` model which is used to generate the final contract document and other | |||
| support models; | |||
|
|
|||
| .. image:: _images/sponsors-db.png | |||
There was a problem hiding this comment.
Not sure if the image (and the dependency that generates it) is necessary here as it is quite complex and I feel more lost with it 😓
JacobCoffee
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR tries to document better the sponsor app to make it easier for other developers to onboard it.
It mostly updates the use cases with docstrings explaining their logic. It also adds an image file with the database schema to the readthedocs page.
To generate the DB schema, I used django-extensions graph model command line interface.