Skip to content

Documentation overhaul #131

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
Merged
merged 6 commits into from
Oct 30, 2020
Merged

Documentation overhaul #131

merged 6 commits into from
Oct 30, 2020

Conversation

@thibaudcolas
Copy link
Member

@thibaudcolas thibaudcolas commented Oct 29, 2020 •
edited
Loading

Description

Reorganises the current documentation into separate pages in the new mkdocs website, so it’s all easier to navigate. Adds much more content based on things that are known to work well on projects, as well as references of DPL’s API, and known issues / limitations.

Fixes #86. Fixes #105. Fixes #98. Fixes #118.

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • I have added an appropriate CHANGELOG entry
@thibaudcolas thibaudcolas force-pushed the chore/documentation-overhaul branch from 2e350da to 453be36 Compare October 29, 2020 12:34
@thibaudcolas thibaudcolas added this to the v0.3.0 milestone Oct 30, 2020
@thibaudcolas thibaudcolas added documentation Improvements or additions to documentation enhancement New feature or request labels Oct 30, 2020
@thibaudcolas thibaudcolas force-pushed the chore/documentation-overhaul branch from 70f4363 to a39b8c9 Compare October 30, 2020 08:33
@thibaudcolas thibaudcolas marked this pull request as ready for review October 30, 2020 08:35
@thibaudcolas thibaudcolas changed the title WIP: Documentation overhaul Documentation overhaul Oct 30, 2020
@thibaudcolas thibaudcolas merged commit 24a5715 into master Oct 30, 2020
@thibaudcolas thibaudcolas deleted the chore/documentation-overhaul branch October 30, 2020 08:37
This was referenced Oct 30, 2020
Open
Open
Closed
Open
Closed
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

2 participants

@thibaudcolas