docs: complete API reference and CONTRIBUTING guide (Phase 2)#23
Merged
AWaterColorPen merged 1 commit intomainfrom Apr 24, 2026
Merged
Conversation
- docs/api.md: full API reference covering Manager, Configuration, Query, TimeInterval, Filter (with operator/value type tables), OrderBy, Limit, and Result types - CONTRIBUTING.md: expand stub into complete contributor guide — dev environment, project layout, test instructions, PR checklist, commit message convention, code style, and new-backend guide - README.md: add API Reference entry to documentation table
87bf6b0 to
493bab6
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Phase 2 — API Reference & CONTRIBUTING Guide
This PR completes the final two Phase 2 documentation tasks.
docs/api.md — Full API Reference (new file)
Covers every public type and function in both the top-level
olapsqlpackage and theapi/typessub-package:NewManager,RunSync,RunChan,BuildSQL,BuildTransaction,SetLogger,GetClients,GetDictionary; each with parameters, return values, and a code exampleRegisterByKV,RegisterByOption,SetLogger,Get,BuildDB,BuildSQL,NewClientsRunSync,RunChan,BuildResultSync,BuildResultChanFilterOperatorTypeconstants with SQL equivalents, leaf vs. tree usage, examplesMetricTypeconstants with SQL patterns; TOML composition exampleDimensionTypeconstantsCONTRIBUTING.md — Complete Contributor Guide (replaces stub)
gofmt, godoc,anyoverinterface{}, no panic in lib code)Part of
Phase 2: Documentation — spec
With this PR, all Phase 2 tasks are complete.