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.

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

Initial reorg of docs #510

Merged
merged 4 commits into from
Jan 10, 2019
Merged

Initial reorg of docs #510

merged 4 commits into from
Jan 10, 2019

Conversation

rossmechanic
Copy link
Collaborator

Description

The docs started with three sections:

  • Quick start
  • Common issues
  • Advanced
    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

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • I have run the make format command to format my code
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • I have added my name and/or github handle to AUTHORS.rst
  • I have added my change to CHANGES.rst
  • All new and existing tests passed.

@codecov-io
Copy link

codecov-io commented Jan 9, 2019

Codecov Report

Merging #510 into master will increase coverage by 0.26%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##           master    #510      +/-   ##
=========================================
+ Coverage   97.63%   97.9%   +0.26%     
=========================================
  Files          17      17              
  Lines         802     905     +103     
  Branches      109     148      +39     
=========================================
+ Hits          783     886     +103     
  Misses          8       8              
  Partials       11      11
Impacted Files Coverage Δ
simple_history/models.py 99.17% <0%> (+0.32%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 32e6289...142a962. Read the comment docs.

kseever
kseever previously approved these changes Jan 9, 2019
Copy link
Collaborator

@kseever kseever left a comment

Choose a reason for hiding this comment

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

👍

@rossmechanic rossmechanic merged commit 45d6f8e into master Jan 10, 2019
@rossmechanic rossmechanic deleted the cleanup-docs branch January 10, 2019 00:12
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