Skip to content

docs: align README, Fern docs, and skills for agent/python/rest workflows#16

Merged
willkill07 merged 1 commit intomainfrom
wkk_agent-friendly
Mar 22, 2026
Merged

docs: align README, Fern docs, and skills for agent/python/rest workflows#16
willkill07 merged 1 commit intomainfrom
wkk_agent-friendly

Conversation

@willkill07
Copy link
Copy Markdown
Member

Summary

  • Align documentation for three primary audiences: coding agents, Python API users, and REST API users.
  • Improve onboarding and consistency across README, CONTRIBUTING, AGENT, Fern docs, and skill playbooks.
  • Add a new Fern REST integration quickstart and clarify generated-doc artifact workflow (openapi.json, config schema, Python reference).
  • Harden the Python reference generation pipeline to remove empty Usage headings.
  • Update skill docs to include clearer validation/cross-links and explicit pre-commit hook behavior (re-stage and re-run commit when hooks auto-fix files).
  • Remove duplicate * 2.* shadow files that could cause doc drift/confusion.

Key Changes

  • README.md: audience routing, naming cheat sheet, end-to-end REST lifecycle examples.
  • CONTRIBUTING.md: corrected API usage examples and release/docs guidance.
  • Fern docs:
    • Added fern/docs/pages/rest/quickstart.mdx
    • Updated nav in fern/docs.yml
    • Updated welcome/python/config pages for discoverability and regeneration guidance.
  • Generated artifacts:
    • Added/tracked fern/openapi.json
    • Added/tracked fern/docs/assets/combined-config.schema.json
    • Refreshed fern/docs/pages/python/reference.mdx
  • scripts/gen_python_api_mdx.py: strip empty generated Usage sections.
  • Skills:
    • Standardized guidance in CI/docs/CLI/API/writers/PR skills
    • Added explicit “hooks may modify files; re-stage and re-commit” instructions.

…lows

Signed-off-by: Will Killian <william.killian@outlook.com>
@willkill07 willkill07 merged commit e4cbb85 into main Mar 22, 2026
4 checks passed
@willkill07 willkill07 deleted the wkk_agent-friendly branch March 22, 2026 23:05
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.

1 participant