IncQL documentation map

This page maps the public documentation for the IncQL project.

Use the docs tree like this:

• Language reference: current package/API contracts under language/reference/
• Language how-to guides: task-oriented workflows under language/how-to/
• Language explanation: conceptual guidance and usage framing under language/explanation/
• Architecture: repository and system boundaries in architecture.md
• RFCs: design records and normative proposals in rfcs/
• Whitepapers: broader non-normative design papers in whitepapers/
• Release notes: shipped and user-visible changes in release_notes/
• Contributing: contributor workflow, especially RFC process, in contributing/writing_rfcs.md

Recommended reading paths

Learn the current package surface

1. Language overview
2. Dataset carriers (Explanation)
3. Execution context (Explanation)
4. Build deferred dataset transformations (How-to)
5. Normalize semi-structured fields (How-to)
6. Work with nested row values (How-to)
7. Expand rows with generators (How-to)
8. Add window columns (How-to)
9. Capture execution observations and adapter coverage (How-to)
10. Observe data quality checks (How-to)
11. Dataset carriers (Reference)
12. Dataset methods (Reference)
13. Execution context (Reference)
14. Inspect a plan and lineage graph (How-to)
15. Local inspection (Reference)

Understand the system design

1. IncQL architecture
2. RFC index
3. Relevant RFCs for deeper normative context

Work on the spec

1. RFC index
2. How to write an RFC

The standalone MkDocs site uses docs/ as the content root. The structure follows the same content model used in Incan: reference, how-to guides, explanation, architecture/contributing, RFCs, whitepapers, and release notes.