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

Initial Documentation #30

Open
slifty opened this issue Sep 16, 2020 · 0 comments
Open

Initial Documentation #30

slifty opened this issue Sep 16, 2020 · 0 comments
Assignees
@slifty

Comments

@slifty
Copy link
Member

slifty commented Sep 16, 2020

Task

Description

I wanted to split out documentation into its own issue so we can talk about what should be in there.

Here's what I have in mind:

  • Introduction
  • Quick Start
  • Building Appliances
  • Consuming Payloads
  • Logging
  • Recipes
    • Extracting Captions
  • API
    • Data Types
    • Countertop
    • Events
    • IAppliance
    • Payload
  • Developing TV Kitchen
    • Contributing
    • Development Environment
    • Testing
    • Resources

Relevant Resources / Research

Looked at the documentation of some other node resources:

Related Issues

Issue #23
@slifty slifty mentioned this issue Sep 16, 2020
Closed
@slifty slifty self-assigned this Sep 16, 2020
piotrfonte pushed a commit that referenced this issue Sep 20, 2020
Rename docs’ sections as outlined in #30.
6592871
@slifty slifty mentioned this issue Sep 22, 2020
Closed
slifty added a commit that referenced this issue Sep 23, 2020
@slifty
Initial documentation
af87245 
There is plenty to add, but this is what we need for initial launch.

Issue #30
@slifty slifty mentioned this issue Sep 23, 2020
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@slifty slifty

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@slifty