-
Notifications
You must be signed in to change notification settings - Fork 1
Description
The goal is to have a 'Reference' section that is owned by the engineers, reviewed accuracy and sufficiently complete.
It might not contain many real-world examples or have a guide-level explanation of how to interact with Amp, but it should be a spec-like reference of Amp's behaviour that guides and tutorials can refer to.
Table of Contents
We can have two high-level sections, "User Reference" and "Operational Reference".
The current "Operational Modes & Deployment Patterns" is already a lot of content that has been engineer reviewed, so all that will be done initially is to rename to "Operational Reference". The "EVM RPC Configuration File" will be moved into a markdown section of it.
For the "User Reference", the focus will be in the semantics of SQL execution and dataset semantics. Examples of specific query clients are out of the initial scope, as those are expected to evolve quickly and have their own docs.
The proposed table of contents is:
- SQL Queries
- Batch Queries
- Streaming Queries
- Query Metadata
- Query Transport
- Built-in Functions
- EVM
- Datasets
- Raw Datasets
- JSON Reference
- Derived Datasets
- JSON Reference
- TypeScript reference
- Raw Datasets