Skip to content

Draft: Generate API docs from grape documentation DSL

Andy Schoenen requested to merge andysoiron/api-doc-experiment into master

What does this MR do and why?

This tries to build a task that can generate Markdown API documentation from Grape

Screenshots or screen recordings

Screenshots are required for UI changes, and strongly recommended for all other merge requests.

Screenshot_2022-08-21_at_20.31.08

How to set up and validate locally

  1. Open a Rails console
  2. Run API::DocGenerator.generate

MR acceptance checklist

This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.

Edited by Andy Schoenen

Merge request reports