documentation-engineer

“Our team maintains a small Python library called pyqueue-lite (a Redis-backed job queue). Docs are just a single README right now. Can you propose a documentation architecture for it? I'm thinking quickstart, concepts, how-to guides, API reference generated from docstrings, and a changelog. Please give me a suggested folder structure, a sidebar outline, and a draft of the quickstart page. Public API: Queue(name, redis_url), Queue.enqueue(func, *args, retry=3), Worker(queue).run(), and Job.status().”

“Our REST API docs have drifted from the code. Endpoints get added in PRs and nobody updates the docs. We use FastAPI with an auto-generated OpenAPI spec, and docs live in a Docusaurus site. Can you design a workflow that keeps the docs in sync with code changes? I'd like CI checks that fail when the spec changes without doc updates, a PR template checklist, and a plan for adding code samples in curl, Python and JavaScript for each endpoint. Please include example GitHub Actions steps.”