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

Setup user-facing documentation for the API #9

Open
2 tasks done
wkyoshida opened this issue Feb 24, 2024 · 2 comments
Open
2 tasks done

Setup user-facing documentation for the API #9

wkyoshida opened this issue Feb 24, 2024 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@wkyoshida
Copy link
Member

Terms

Issue

This issue is for setting up the user-facing documentation for using the Scribe-Server API. Creation of all the content will be tracked in separate issues, but may include:

  • usage examples
  • explanations/descriptions of the data

Some ideas for setting this up are via:

@wkyoshida wkyoshida added the documentation Improvements or additions to documentation label Feb 24, 2024
@wkyoshida wkyoshida self-assigned this Feb 24, 2024
@wkyoshida
Copy link
Member Author

Hey @Jk40git - tagging you here real quick to keep you in the loop ✌️

This issue will be more for figuring out where/how to host the user-facing documentation, but once that's done, we can look into writing up some of the content for user-facing docs. I'll create issues for those when the time comes so we can then work on them 😉

@Jk40git
Copy link

Jk40git commented Feb 25, 2024

Hey @Jk40git - tagging you here real quick to keep you in the loop ✌️

This issue will be more for figuring out where/how to host the user-facing documentation, but once that's done, we can look into writing up some of the content for user-facing docs. I'll create issues for those when the time comes so we can then work on them 😉

Noted with thanks @wkyoshida

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
Projects
Status: Todo
Development

No branches or pull requests

2 participants