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

Split docs into tutorials, reference and how-tos #62

Closed
jaypipes opened this issue Sep 24, 2017 · 0 comments
Closed

Split docs into tutorials, reference and how-tos #62

jaypipes opened this issue Sep 24, 2017 · 0 comments
Labels
docs
Milestone
0.6

Comments

@jaypipes
Copy link
Owner

I can't seem to find a link to the great article I read on medium.com about the four different types of documentation, but I do remember that the article explained why it was important to have tutorials, how-tos, and reference documentation separated from each other and use different writing strategies for each.
@jaypipes jaypipes added the docs label Sep 24, 2017
@jaypipes jaypipes added this to the 0.6 milestone Sep 24, 2017
jaypipes added a commit that referenced this issue Sep 24, 2017
@jaypipes
Begin restructuring documentation
26276cf 
Adds an aspirational README to the docs/ directory describing the four
different types of documentation we wish to have.

Issue #62
jaypipes added a commit that referenced this issue Sep 24, 2017
@jaypipes
Adds a Getting Started guide
b62b150 
Adds a walkthrough of how to get started using the `sqlb` library,
including pulling sqlb as a dependency, discovering schema metadata and
building your first SQL expression using `sqlb.Select()`

Issue #62
This was referenced Sep 24, 2017
Merged
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs
Projects
None yet
Milestone
0.6
Development

No branches or pull requests
1 participant
@jaypipes