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.
Description
The docs started with three sections:
This made sense when the project was first started, but as features and documentation have been added, doc organization has gotten pretty terrible. Just looking at the advanced section of the docs can be pretty confusing, which doesn't make it any easier for new developers to start using and contributing to
django-simple-history
. This PR is an initial attempt to reorganize the docs, making it easier to figure out where to add new documentation in the future. This is also a good first step to cleaning up and editing a lot of the existing documentation (which I intend to do in future PRs).How Has This Been Tested?
Screenshots (if appropriate):
Types of changes
Checklist:
make format
command to format my codeAUTHORS.rst
CHANGES.rst