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

docs: initial gitbook docs #336

Merged
merged 35 commits into from
Sep 30, 2022
Merged

docs: initial gitbook docs #336

merged 35 commits into from
Sep 30, 2022

Conversation

brizzbuzz
Copy link
Contributor

@brizzbuzz brizzbuzz commented Sep 29, 2022

Description

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Closes #335
Closes #188

Type of change

Please delete options that are not relevant.

  • 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 not work as expected)
  • Documentation
  • Chore

How Has This Been Tested?

Please describe the tests that you ran to verify your changes.

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
  • I have updated the CHANGELOG in the Unreleased section
  • 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
  • Any dependent changes have been merged and published in downstream modules

@brizzbuzz brizzbuzz marked this pull request as ready for review September 29, 2022 20:56
@brizzbuzz brizzbuzz added the WIP label Sep 29, 2022
@brizzbuzz brizzbuzz removed the WIP label Sep 30, 2022
@brizzbuzz brizzbuzz merged commit 1759be5 into main Sep 30, 2022
@brizzbuzz brizzbuzz deleted the docs/initial branch September 30, 2022 02:36
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.

Write initial Gitbooks documentation Make Documentation easier to follow
1 participant