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.

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

How do we want to document the SDK? #2

Open
slifty opened this issue Feb 7, 2022 · 0 comments
Open

How do we want to document the SDK? #2

slifty opened this issue Feb 7, 2022 · 0 comments

Comments

@slifty
Copy link
Contributor

slifty commented Feb 7, 2022

We don't have to answer this in order to start coding, but it would be good to address this question as early as possible so that we can be sure to document as we develop.

How and where do we want to document the SDK?

Do we want a separate repository for documentation that is powered by a static site generator, such as Docusaurus? Do we want to put it in something like a docs/API.md file? Use the github wiki? Something entirely different?
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@slifty