Improve documentation
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 6.5k
- Forks
- 456
- Avg merge
- 1d 5h
- Merged PRs (30d)
- 5
Description
We should potentially improve our documentation around some of the slightly "fuzzier" aspects of ShareDB. Some things that have come up recently are:
Doclifecycle - how to properly get, fetch, and destroy documents; should also point out gotchas like the fact that there's a caching layer on the connection, so if I doconnection.gettwice, I don't have two independent instances ofDoc(eg if I wanted tosubscribeon one, but justfetchon the other, it's non-obvious that these two documents are secretly the same thing); also you can'tdoc.destroyand thendoc.fetch, etc.- authentication - there's a short mention of a plugin in the
README, but it doesn't address some of the weirder cases, like trying to authenticaterich-text(which doesn't have a logical place to store metadata on the document itself). We should also point out that things like ops should be secured as well as documents (which can be a bit non-obvious when coming from a more "traditional" data store)
In general, I kind of think we've out-grown the README, and it might be nice to throw together some sort of HTML documentation, with code snippets, etc., but obviously that'll be quite a lot of work.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the README's existing authentication plugin section and the documentation around the Doc lifecycle, connection.get, fetch, destroy, and rich-text authentication. Define the documentation scope before choosing between an expanded README and HTML pages; done means the lifecycle, caching, authentication, and operation-security cases are explained with useful code snippets.
Written by the indexing model from the issue text.
Assessment
- Domain
- authentication, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100