At present the documentation consists of a few codeproject articles. Those articles are FANTASTIC for a detailed discussion on the entire process from a design and learning perspective BUT for a user looking to get started with RaptorDb, it doesn't allow
them to complete certain basic tasks.
For RaptorDb to have greater traction and popularity, the documentation should enable user's to complete their development tasks efficiently (rather than each user piecing together the data across the articles).
- A "quick start" guide on THIS site as an authoritative source, which shows how users can get the library (hopefully over NuGet) and enabled them to with basic operations.
- Document the API, configuration options and their impact to RaptorDb (perhaps using the Code XML comments?)
To illustrate that using design articles as a substitute for task-oriented documentation = problems, here is an example (no eventual consistency here!):
Latest codeproject article is at
and shows using
to perform key operations but nowhere does is specify how to initialize
. The other codeproject article at
DOES initialize it but does so in a manner inconsistent with the WinForms test project source code's