Skip to content

docs: add API reference with full type and method documentation #30

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AWaterColorPen merged 1 commit into from
Apr 22, 2026
Merged

docs: add API reference with full type and method documentation #30

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,7 @@ stage, err := playground.NewPlaygroundWithSqlitePath(t.TempDir())
| [Getting Started](./docs/getting-started.md) | Step-by-step guide with complete runnable examples |
| [Configuration](./docs/configuration.md) | All config options: DB, dictionary, watcher |
| [Design](./docs/design.md) | Architecture and design decisions |
| [API](./docs/api.md) | Full service method reference |
| [API Reference](./docs/api-reference.md) | Full type and method reference with parameters, return values, and usage notes |

## Storage backends

Expand Down
Loading
Loading