Skip to content

Conversation

@alexzerntev
Copy link
Contributor

@alexzerntev alexzerntev commented Dec 17, 2025

Description

Documentation updates

Type of Change

  • πŸ› Bug fix (non-breaking change which fixes an issue)
  • ✨ New feature (non-breaking change which adds functionality)
  • πŸ’₯ Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • πŸ“ Documentation update
  • πŸ”§ Refactoring (no functional changes, no api changes)
  • ⚑ Performance improvement
  • πŸ§ͺ Test improvement
  • πŸ”’ Security fix

Testing

  • Tests pass locally with uv run pytest
  • Linting passes with uv run ruff check .
  • Code formatting passes with uv run black --check .
  • Type checking passes with uv run mypy .
  • Added tests for new functionality (if applicable)
  • Updated documentation (if applicable)

Security Considerations

  • This change does not introduce security vulnerabilities
  • Sensitive data handling reviewed (if applicable)
  • Policy enforcement implications considered (if applicable)

Breaking Changes

If this is a breaking change, describe what users need to do to migrate:

Additional Notes

Any additional context or screenshots.


Note

Major docs revamp adding full reference (CLI/SQL/Python/Plugins), tutorials, security (auth/policies/auditing), operations (deployment/monitoring/admin), integrations (Claude/dbt/DuckDB), schemas, examples, and common tasks.

  • Docs Overhaul:
    • Reference: New docs/reference/ for CLI, SQL, Python runtime, Plugins, Common Tasks; top-level index.
    • Tutorials: Added Hello World, SQL endpoints, Python endpoints with tested examples.
    • Security: Added Authentication (OAuth providers), Policies (CEL), Auditing guides.
    • Operations: Deployment, Configuration, Monitoring (OTEL), Admin Socket, Drift Detection, Audit Cleanup.
    • Integrations: Claude Desktop, dbt, DuckDB.
    • Schemas: YAML schema refs for site/user config, tool/resource/prompt.
    • Concepts & Getting Started: Core concepts, endpoints, project structure, production methodology; refreshed intro/quickstart/glossary.
    • Examples & Contributing: New example projects and contributor guide.
    • Housekeeping: Removed legacy category JSONs; added archived reference copies.

Written by Cursor Bugbot for commit 3ddf643. This will update automatically on new commits. Configure here.

@alexzerntev alexzerntev merged commit 15c9e22 into main Dec 18, 2025
17 checks passed
@alexzerntev alexzerntev deleted the docs-update branch December 18, 2025 10:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants