http-rs / http-rs/tide-book

What should be in the documentation?

Open
#1 5 comments 0 reactions 0 assignees View on GitHub
Dominant language
No language data
Stars
9
Forks
6
PR merge metrics
No merged PRs in 30d

Description

I thought I'd open an issue to discuss where we want to take the Tide Book and write down my own thoughts.

The documentation right now is just something I threw together. I think the current subdivision can work pretty well;
- Intro
- Server, routes and endpoints
- Request and response
- State
- Middleware
We do need to be careful that the documentation will be use-case driven. "How do I do x", and not too component-driven: "thing a does x, y and z" That last kind of documentation is already on docs.rs.

I think that once we expand on the subjects they can be subdivided into sub-chapters.

After these chapters I would like to add some sort of grab-bag chapter with assorted use-cases. The json chapter could be part of that, and other examples could go there too. How do I use Tide with a database, how do I use Tide with a template engine etc.

The further reading chapter can be an appendix A, maybe we can have more appendices. Links to tools and other libraries etc.

Am I missing any subjects? Any ideas on a different way to split up chapters?

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.