메뉴
Maintains Fern documentation, OpenAPI, JSON Schema assets, and Python API reference MDX for this project. Use when changing FastAPI routes, public docstrings, Pydantic config models, or user-facing docs under fern/docs.
Codex 또는 Claude로 설치 이 Prompt를 복사해 Codex, Claude 또는 다른 어시스턴트에 붙여 넣으면 Skill 페이지를 검토하고 설치를 진행할 수 있습니다.
SOC 직업 분류 기준
| name | sched-fern-openapi-docs |
| description | Maintains Fern documentation, OpenAPI, JSON Schema assets, and Python API reference MDX for this project. Use when changing FastAPI routes, public docstrings, Pydantic config models, or user-facing docs under fern/docs. |
fern/openapi.json — generated from FastAPI.fern/docs/assets/combined-config.schema.json — generated from config models.fern/docs/pages/python/reference.mdx — generated from docstrings (see script).| Change | Command |
|---|---|
server.py, API models, routes | uv run python scripts/export_openapi.py |
CombinedConfig / config schema | uv run python scripts/export_config_schema.py |
| Public API docstrings | uv run python scripts/gen_python_api_mdx.py |
Quick decision guide:
src/scheduler/server.py -> run export_openapi.pysrc/scheduler/config.py or related config models -> run export_config_schema.pysrc/scheduler/ -> run gen_python_api_mdx.pyfern/docs/pages/ (MDX), navigation in fern/docs.yml.fern/fern.config.json, fern/generators.yml.After regenerating as needed: install Fern CLI (npm install -g fern-api), then fern docs dev from the fern/ directory (see CONTRIBUTING).
Docs deployment is in .github/workflows/docs.yml — keep generated artifacts committed when CI or publishers expect them.
Cross-skill references:
Changes the scheduler command-line interface in main.py (Click), arguments, output paths, and format options. Use when adding CLI flags or adjusting how schedules are printed or written to disk.
Implements or debugs scheduling logic, Z3 constraints, and JSON configuration for the course constraint scheduler. Use when working in scheduler.py, config models, time slots, or solver behavior.
Changes or reviews the FastAPI REST server, routes, and HTTP behavior for the scheduler. Use when editing server.py, async job flow, or API contracts.
Interprets or updates GitHub Actions workflows for linting, tests, docs, and publishing. Use when CI fails, when adding checks, or when aligning local commands with automation.
Maintains TypedDict and JSON-shaped type definitions for API and config payloads. Use when editing json_types.py or aligning wire formats with Pydantic models and OpenAPI.
Maintains or extends repository scripts under scripts/ for OpenAPI export, JSON Schema export, and Python API MDX generation. Use when changing export pipelines or adding codegen steps for documentation.