API reference

A step of the Open source library tree on Gradus, in the Project hygiene area: License, README, docs.

Generate reference documentation from the source's doc comments and publish it on every release.

Usually comes after: README with a quick start.

Prompt for your AI assistant

Set up API reference generation from the source's documentation comments using the standard tool for this ecosystem, add a docs script to the package manifest and publish the output to a static site (GitHub Pages or similar) from the release workflow.

• Show on map
• This step as Markdown
• Every step of the tree, for AI assistants

This is https://gradus.kazet.blog/tree/open-source-library/step/api-reference as plain HTML. In a browser the page also lets you mark the step forged and copy a message for your AI assistant.