Skip to content

Latest commit

 

History

History
36 lines (32 loc) · 1.81 KB

File metadata and controls

36 lines (32 loc) · 1.81 KB

The duckdb-r handbook

The single source of truth for every documentable aspect of this package; internal pages like this one navigate and state their area's principles, leaves explain (meta/handbook/).

The areas divide by what a question is about, not by who is asking it. A reader who only installs the package and one who maintains the repository are served by the same tree, and the same question brings both to the same leaf — an audience split would need the same fact in two places, and the tree holds every fact once.

Two bodies of writing stay outside the tree, and the handbook says what each owns and links it rather than restating either. plan/ holds intent: a design for work not done, and the record of one that came true or was overtaken. experiments/ holds the evidence a leaf leans on: what was measured, when, and on what. A leaf that paraphrases a plan has created a second copy of a proposal. A leaf that copies out a measurement has created a second copy of a record that ages.

  • usage/ — installation and flavors, connections, statements, types, timestamps, extensions, memory, data import, storage, integrations, the relational API, interactive use
  • architecture/ — the R layer, the C++ glue, the embedded engine, the rfuns extension
  • build/ — source build, fast paths, build knobs, compiler warnings
  • testing/ — suite, snapshots, guards, revdep
  • branches/ — series, mirrors, flavors, invariants
  • operations/ — vendoring, triage, review, CI, releases, the site
  • contributors/ — setup, workflow, where to help
  • meta/ — the rules, the authoring checklist, the plans, the glossary