Skip to content

Conversation

berinhard
Copy link
Contributor

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.

@berinhard berinhard requested a review from ewdurbin November 25, 2021 20:54
@@ -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
Copy link
Member

Choose a reason for hiding this comment

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

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 JacobCoffee changed the title Topic/sponsorship uc documentation docs: enhance sponsorship uc documentation Sep 16, 2024
@adityaraute
Copy link

adityaraute commented Apr 15, 2025

Does this PR still need a change?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants