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

Create Developer Documentation #10

Closed
jhoshiko opened this issue Apr 18, 2022 · 5 comments
Closed

Create Developer Documentation #10

jhoshiko opened this issue Apr 18, 2022 · 5 comments
Assignees

Comments

@jhoshiko
Copy link
Collaborator

Create developer documentation. Some sections we could include:

  • Get started or quick start guide

  • a variety of examples/use cases ranging from simple to complex

  • API documentation

  • matcher documentation

@Thomas-McKanna Thomas-McKanna self-assigned this May 2, 2022
@Rowlando13
Copy link
Collaborator

I think we should close this and split this issue into the following issues:

  1. Getting started or quick start - possibly not open if it is good enough for now.
  2. General review of documentation structure - should be done in a multiple PRs so as to not block people / generate a lot of conflicts.
  3. Developer documentation
    • Developer specific install
    • Workflow for contribution
    • others TBD
  4. API documentation - possibly not open if it is good enough for now.
  5. Matcher documentation - possibly not open if it is good enough for now.

@Rowlando13
Copy link
Collaborator

@jhoshiko @nreinicke Thoughts?

@nreinicke
Copy link
Collaborator

I like the idea of open separate issues for all of these. At a minimum it would be nice to comb through each section and confirm that it looks okay (since we had a whirlwind of modifications during the sprint).

@Rowlando13
Copy link
Collaborator

Sounds like we should open the issues, then close them as we check.

@Rowlando13
Copy link
Collaborator

Opened #113 , #114 , #115 , #116 , #117 . Closing issue.

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

No branches or pull requests

4 participants