update-public-docs

Solid

Update public API reference docs to match Python source code. Compares client.py, schema files, and config models against MDX docs and fixes any gaps. Triggers on: update docs, sync docs, update public docs, update api reference, refresh documentation.

AI & Automation 516 stars 54 forks Updated yesterday Apache-2.0

Install

View on GitHub

Quality Score: 91/100

Stars 20%
90
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# Update Public Docs Keep the public documentation at `reflexio/public_docs/` in sync with the Python source code (client library, schemas, config models). ## Source Files (authoritative) Read these files to understand the current API surface: - `reflexio/reflexio_client/reflexio/client.py` — All public client methods (defines what's client-facing) - `reflexio/reflexio_commons/reflexio_commons/api_schema/service_schemas.py` — Data models, enums, request/response schemas - `reflexio/reflexio_commons/reflexio_commons/api_schema/retriever_schema.py` — Search/get request/response models - `reflexio/reflexio_commons/reflexio_commons/config_schema.py` — Configuration models ## Documentation Files (to update) Read all MDX docs under `reflexio/public_docs/content/docs/`: - `api-reference/client-*.mdx` — Client method documentation - `api-reference/schemas-*.mdx` — Schema/model documentation - `concepts/` — Core concept pages - `getting-started/` — Quickstart and setup guides - `examples/` — Usage examples ## Workflow ### Step 1: Read All Sources Read every source file listed above. Extract: - All public methods from `ReflexioClient` (name, parameters with types/defaults, return type, docstring) - All public Pydantic models used by those methods (field name, type, required/optional, default, description) - All enum classes and their values - All config model fields ### Step 2: Read All Documentation Read every MDX file under `reflexio/public_docs/content/docs/`. ### Step ...

Details

Author
ReflexioAI
Repository
ReflexioAI/claude-smart
Created
1 months ago
Last Updated
yesterday
Language
Python
License
Apache-2.0

Similar Skills

Semantically similar based on skill content — not just same category