Skip to content

Latest commit

 

History

History
64 lines (48 loc) · 7.14 KB

File metadata and controls

64 lines (48 loc) · 7.14 KB

📚 DevRel & API Documentation

API docs, OpenAPI references, SDK generation, docs-site publishing, prose linting, and developer enablement workflows.

Who this is for

  • DevRel, API platform, SDK, and documentation teams maintaining references, examples, and docs sites.
  • Teams that need agents to validate docs and API contracts before publishing.

Jobs covered

  • Render and lint OpenAPI references.
  • Generate typed clients and SDK docs.
  • Build and publish versioned documentation sites.
  • Check Markdown links and prose quality before release.

Workflow Stacks

  • API reference release: Bundle OpenAPI → lint contract → generate clients → publish docs → check links
  • Docs quality pass: Run prose lint → verify links → preview site → ship versioned docs
  • Code-aware docs maintenance: Generate TypeScript reference → validate Python docstrings → open docs-update PR → verify links → publish versioned docs

Recommended Picks

Skill What it does here Persona Install Stars
Redoc OpenAPI Documentation Renderer Publishes clean OpenAPI references for API consumers who need fast navigation. API docs engineer / DevRel Medium 25.6k
Scalar OpenAPI Reference and API Client Platform Combines reference docs and request testing so developers can inspect endpoints in context. DevRel engineer / API platform PM Medium 14.6k
Redocly CLI OpenAPI Linter and Documentation Generator Bundles linting, validation, bundling, and docs generation in one OpenAPI release gate. API governance lead / docs engineer Medium 1.4k
DevDocs Unified API Documentation Browser Gives agents and developers a fast offline-searchable API reference surface. Developer advocate / support engineer Low 38.7k
MkDocs Project Documentation Generator Provides a stable Markdown-to-docs-site path for project and internal docs. Technical writer / developer educator Medium 21.9k
Fumadocs React Documentation Framework and Docs Site Generator Fits React/Next.js docs teams that need a modern docs framework rather than a static-only stack. Frontend docs engineer High 11.5k
Vale Prose Linter for Technical Documentation Catches style, terminology, and readability drift before generated docs ship. Technical editor / docs lead Low 5.3k
Orval OpenAPI Client Regeneration Skill for Typed SDKs Regenerates typed API clients from OpenAPI specs so examples and SDKs stay aligned. SDK engineer / API platform engineer Medium 5.7k
Spectral OpenAPI and AsyncAPI Linter Enforces API style and contract rules before docs or generated clients depend on the spec. API governance / platform engineer Low 3.1k
Bundle and validate OpenAPI files into one publishable spec with swagger-cli Compiles multi-file OpenAPI definitions into one artifact for publishing or review. API docs engineer / CI maintainer Low 517
Resolve and validate OpenAPI specs with remote refs before client generation or review with Prance Resolves remote references so codegen and docs are based on the actual compiled contract. API integration engineer Low 261
Run .http and .rest request files with variables, hooks, and assertions during local or CI checks with httpYac Turns API examples into executable checks that catch stale docs and broken sample flows. DevRel engineer / QA engineer Medium 809
Publish versioned MkDocs documentation with mike Keeps older docs versions available while publishing new releases. Docs release manager Medium 728
Verify Markdown links before docs or content ship with markdown-link-check Catches broken links across docs and README files before they reach developers. Technical writer / docs QA Low 693
TypeDoc TypeScript API Documentation Generator Adds TypeScript API documentation generation, a major docs workflow not currently represented in the collection. SDK engineer / docs engineer Low 8.4k
Update repository docs automatically after code changes and open review PRs Lets agents open reviewable docs-update PRs after code changes, reducing stale developer documentation. DevRel engineer / docs maintainer Medium
Validate Python Docstrings Against Function Signatures with pydoclint Catches stale Python docstrings when APIs change, improving generated and maintained reference docs. Python library maintainer / docs QA Low 208
OpenAPI Generator API Client and Server Stub Tooling Generates client SDKs and server stubs from OpenAPI specs, closing the loop between API documentation and usable developer artifacts. SDK engineer / API platform team Medium 26.1k
Swagger UI Documentation Deployer Publishes interactive API references from OpenAPI specs so developers can inspect endpoints without custom docs infrastructure. API docs maintainer / DevRel engineer Low 28.8k
Bootstrap an OpenAPI spec from captured API traffic before client or test automation starts Turns captured API traffic into a starter OpenAPI spec before client generation, docs cleanup, or test automation. API platform engineer / integration lead Medium 9.3k

Editorial Notes

  • The collection emphasizes developer enablement over generic engineering utilities.
  • Tools should reduce stale docs, broken references, or SDK drift.
  • Frame this as developer enablement and API documentation, not a generic software-industry bucket.

Adjacent Collections


← Back to industry collections