Agent SkillsReflexioAI/claude-smart › update-public-docs

update-public-docs

GitHub

同步Python源码与MDX文档,确保API参考、Schema、配置及示例准确无误。通过比对client.py和schema文件修复文档差异,并执行构建验证。

.agents/skills/update-public-docs/SKILL.md ReflexioAI/claude-smart

Trigger Scenarios

update docs sync docs update public docs update api reference refresh documentation

Install

npx skills add ReflexioAI/claude-smart --skill update-public-docs -g -y
More Options

Non-standard path

npx skills add https://github.com/ReflexioAI/claude-smart/tree/main/.agents/skills/update-public-docs -g -y

Use without installing

npx skills use ReflexioAI/claude-smart@update-public-docs

指定 Agent (Claude Code)

npx skills add ReflexioAI/claude-smart --skill update-public-docs -a claude-code -g -y

安装 repo 全部 skill

npx skills add ReflexioAI/claude-smart --all -g -y

预览 repo 内 skill

npx skills add ReflexioAI/claude-smart --list

SKILL.md

Frontmatter
{
    "name": "update-public-docs",
    "description": "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."
}

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:

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

Version History

  • 951e081 Current 2026-07-24 11:42

Same Skill Collection

.agents/skills/agent-browser/SKILL.md
.agents/skills/fastapi/SKILL.md
.agents/skills/prd/SKILL.md
.agents/skills/ralph/SKILL.md
.agents/skills/sync-agent-instructions/SKILL.md
.claude/commands/check-and-test/SKILL.md
.claude/commands/create-pr/SKILL.md
.claude/commands/review/SKILL.md
.claude/commands/run-services/SKILL.md
.claude/commands/update-pr/SKILL.md
.claude/skills/agent-browser/SKILL.md
.claude/skills/fastapi/SKILL.md
.claude/skills/prd/SKILL.md
.claude/skills/ralph/SKILL.md
.claude/skills/sync-agent-instructions/SKILL.md
.claude/skills/update-public-docs/SKILL.md
plugin/skills/claude-smart/SKILL.md
.claude/commands/commit/SKILL.md

Metadata

Files
0
Version
2fe23d0
Hash
44f5aba9
Indexed
2026-07-24 11:42

Главная - Вики-сайт
Copyright © 2011-2026 iteam. Current version is 2.155.2. UTC+08:00, 2026-08-06 17:31
浙ICP备14020137号-1 $Гость$