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

Documentation #174

Open
wants to merge 13 commits into
base: master
Choose a base branch
from
Open

Documentation #174

wants to merge 13 commits into from

Conversation

ReeceM
Copy link
Collaborator

@ReeceM ReeceM commented Sep 13, 2021

Description

This PR forms the base of adding documentation to the package, dedicated inside of the repo.

Related Issue

#167, #153 , #99

Motivation and Context

How Has This Been Tested?

In progress dev. Not related to core operation of the package

Screenshots (if appropriate):

Types of changes

  • ✅ New feature (non-breaking change which adds functionality)

Checklist:

  • Add Installation Page
  • Add Troubleshooting Page
  • Add References to Configs
  • Usage Examples
  • Configuration Examples
  • Template Usage
  • Caveats, Workarounds
  • Upgrade Guides

@ReeceM ReeceM added enhancement New feature or request Docs PRs or Issues that are related to the documentation labels Sep 13, 2021
@ReeceM ReeceM linked an issue Jun 5, 2022 that may be closed by this pull request
@ReeceM ReeceM marked this pull request as ready for review June 5, 2022 17:54
@ReeceM ReeceM requested a review from Qoraiche June 11, 2022 16:31
@ReeceM
Copy link
Collaborator Author

ReeceM commented Jun 11, 2022

Hey @Qoraiche,

If you can could you have a look through this on a local version and see what can be added? Or adjusted. It would be great 👍

@Qoraiche
Copy link
Owner

Hey @ReeceM,

Thanks for this PR , it looks good to me 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs PRs or Issues that are related to the documentation enhancement New feature or request
Projects
None yet
2 participants