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

Beta > Alpha #32

Merged
merged 6 commits into from
Dec 5, 2020
Merged

Beta > Alpha #32

merged 6 commits into from
Dec 5, 2020

Conversation

enpaul
Copy link
Owner

@enpaul enpaul commented Dec 5, 2020

  • Overhaul documentation
    • Add more useful documentation of error states and potential solutions
    • Add clearer documentation of plugin-provided configuration options
    • Add embeded links for easier navigation around the readme
    • Add download badge
    • Add instructions for handling Poetry's unsafe dependencies (Fixes Mitigate "UNSAFE_DEPENDENCIES" issue #6)
    • Add documentation of unsupported Tox configuration options (Fixes Logging warnings when unsupported config options are set #5)
    • Fix misc problems with the developer, contributor, and roadmap docs that came from not being updated in a while
  • Update PyPI project classification from 3 - Alpha to 4 - Beta

@enpaul enpaul added docs Improvements or additions to documentation roadmap-beta labels Dec 5, 2020
enpaul added 3 commits December 5, 2020 18:30
@enpaul
Rewrite usage reference documentation to improve clarity
03f46d3 
Add more details to error documentation
Update error and option documentation to be referenceable via slugs
Add docs for missing --require-poetry option
Add more crosslinks to assit with navigation
@enpaul
Reorder TOC
ea518d1 
Add garbage to email to (hopefully) avoid scraping
@enpaul
Overhaul basic usage documentation to improve clarity
0ad5fb7 
Add intra document links
Update to document new/updated features
Add badge for downloads per month
Update badge order
@enpaul enpaul merged commit ff344c2 into devel Dec 5, 2020
@enpaul enpaul deleted the enp/docs branch December 5, 2020 23:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
docs Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Mitigate "UNSAFE_DEPENDENCIES" issue Logging warnings when unsupported config options are set
1 participant
@enpaul