update-public-docs
The update-public-docs skill synchronizes API reference documentation in MDX format with the authoritative Python source code by comparing client methods, data schemas, enums, and configuration models, then updates documentation files to fix discrepancies in method signatures, field definitions, and code examples. Use it when the Python client library, schemas, or configuration models change to ensure public documentation remains current and accurate.
git clone --depth 1 https://github.com/ReflexioAI/claude-smart /tmp/update-public-docs && cp -r /tmp/update-public-docs/.claude/skills/update-public-docs ~/.claude/skills/update-public-docsSKILL.md
# 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 3: Compare and Update For each doc category, compare source against docs and fix discrepancies: **Client methods** (`client-*.mdx`): - Every public method in `client.py` must be documented - Parameters: correct name, type, required/optional, default value - Return type and response schema must match - Remove docs for methods that no longer exist **Schema docs** (`schemas-*.mdx`): - Every field in each Pydantic model must appear in the documentation tables - Field name, type, required/optional, default, and description must match source - Remove docs for models/fields that no longer exist **Enums** (`schemas-enums.mdx`): - All enum values must be listed with correct string values **Config docs** (`schemas-config.mdx`): - All config model fields must match source **Concepts/examples** (`concepts/`, `getting-started/`, `examples/`): - Check for references to deprecated or renamed features, methods, or fields - Update any stale code snippets ### Step 4: Scope Rules **INCLUDE:** - All methods in `ReflexioClient` - All public Pydantic models used by those methods - All enums - Config models **EXCLUDE:** - Internal API endpoints (`api.py` internals) — only document what's exposed through `client.py` - Skill-related features (disabled) - Private/internal helper methods - Implementation details ### Step 5: Verify Build Run the docs build to ensure no errors: ```bash cd reflexio/public_docs && npx next build ``` Fix any build errors before finishing. ### Step 6: Report Summarize what changed: - New methods/models/fields documented - Updated parameters, types, or defaults - Removed stale documentation - Any build issues encountered and how they were resolved
Browser automation CLI for AI agents. Use when the user needs to interact with websites, including navigating pages, filling forms, clicking buttons, taking screenshots, extracting data, testing web apps, or automating any browser task. Triggers include requests to "open a website", "fill out a form", "click a button", "take a screenshot", "scrape data from a page", "test this web app", "login to a site", "automate browser actions", or any task requiring programmatic web interaction.
FastAPI best practices and conventions. Use when working with FastAPI APIs and Pydantic models for them. Keeps FastAPI code clean and up to date with the latest features and patterns, updated with new versions. Write new code or refactor and update old code.
Generate a Product Requirements Document (PRD) for a new feature. Use when planning a feature, starting a new project, or when asked to create a PRD. Triggers on: create a prd, write prd for, plan this feature, requirements for, spec out.
Convert PRDs to prd.json format for the Ralph autonomous agent system. Use when you have an existing PRD and need to convert it to Ralph's JSON format. Triggers on: convert this prd, turn this into ralph format, create prd.json from this, ralph json.
Sync AI coding tool instruction files (CLAUDE.md, GEMINI.md, AGENTS.md) so they stay aligned. Detects which file changed and copies it to the others. Use when syncing md files, syncing instructions, updating GEMINI.md, or updating AGENTS.md.
Git commit workflow with precommit hook handling, lint/type checking, README updates, and API reference updates. Use when the user wants to commit changes. Handles precommit hooks that modify files (formatting, linting) by re-staging and retrying. Runs ruff lint and pyright type checks on staged Python files, and Biome lint and tsc type checks on staged TS/JS files, fixing all errors. Fixes failing unit tests automatically before committing. Updates README code maps if needed. Updates API reference docs when client.py or service_schemas.py changed. Does not push.
Create high-quality pull requests via gh pr create. Use when the user wants to create a PR, submit a PR, open a pull request, submit for review, or push changes for review. Triggers on: create a pr, create-pr, submit a pr, open a pull request, submit for review, make a pr, gh pr create.
Rigorous code review of all uncommitted changes. Analyzes architecture, code quality, security, and engineering best practices. Embeds questions and assumptions inline, then summarizes all proposed changes as a plan for user approval before any edits are made.