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

ADOR '16 Hack Day - Documentation team #2147

Closed
ifyouwillit opened this Issue Jan 29, 2016 · 3 comments

Comments

Projects
None yet
3 participants
@ifyouwillit

ifyouwillit commented Jan 29, 2016

Questions:
What's the best way for documentation to be presented?
We should have more examples in documentation
Should we integrate with code reference?

Areas of documentation
Comments
API reference
Landing page
Endpoints responses
Extending the API
Examples

Good examples of documentation
Stripe
Backbone
Twilio
Trello
GitHub API console
Digital Ocean

What we can do today?
Tutorials
Code snippets / examples
Landing page
Marketing
Slack channel
How to contribute
Ask for feedback
Solve general deficiencies in GitHub documentation
Technical FAQ - Use case - answer / example
Get V2 to the level of V1

Tom - Changing title of V1 / re-directing doc to V2
Kirsten / Jack - Make more responsive
Mendel / Vitor - Audit V1 -> V2
Aaron - Commit

@ifyouwillit ifyouwillit changed the title from REST API Hack Day (ADOR '16) - Documentation team to ADOR '16 Hack Day - Documentation team Jan 29, 2016

@aaronjorbin

This comment has been minimized.

Show comment
Hide comment
@aaronjorbin

aaronjorbin Jan 29, 2016

Contributor

Today, the Docs team:

  1. Formally Deprecated v1 documentation
  2. Removed ADoR banner on the documentation
  3. Worked on migrating examples and guides from v1 to v2
  4. Started making docs responsive
  5. Started listing out actual responses and filling out v2 docs
Contributor

aaronjorbin commented Jan 29, 2016

Today, the Docs team:

  1. Formally Deprecated v1 documentation
  2. Removed ADoR banner on the documentation
  3. Worked on migrating examples and guides from v1 to v2
  4. Started making docs responsive
  5. Started listing out actual responses and filling out v2 docs
@danielbachhuber

This comment has been minimized.

Show comment
Hide comment
@danielbachhuber

danielbachhuber Feb 2, 2016

Member

@ifyouwillit @aaronjorbin could be break this into some actionable issues for the docs repo?

Member

danielbachhuber commented Feb 2, 2016

@ifyouwillit @aaronjorbin could be break this into some actionable issues for the docs repo?

@ifyouwillit

This comment has been minimized.

Show comment
Hide comment
@ifyouwillit

ifyouwillit Feb 2, 2016

@danielbachhuber good point. @aaronjorbin was there any work completed after your report?

ifyouwillit commented Feb 2, 2016

@danielbachhuber good point. @aaronjorbin was there any work completed after your report?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment