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

Rebuild EXPLAINER.md as developer-facing documentation #108

Open
reillyeon opened this issue Oct 13, 2017 · 0 comments
Open

Rebuild EXPLAINER.md as developer-facing documentation #108

reillyeon opened this issue Oct 13, 2017 · 0 comments

Comments

@reillyeon
Copy link
Collaborator

The tag recommends building an explainer document as developer-facing documentation as extracting information about how to use an API from the full specification is difficult. This will likely include copies of the examples from the specification but with more developer-centric explanations.

Ideas I have for this include a walkthrough of not only how to connect to a device but also how the device is expected to behave as this is a common developer question.
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
@reillyeon