Skip to content

Latest commit

 

History

History
13 lines (11 loc) · 579 Bytes

README.md

File metadata and controls

13 lines (11 loc) · 579 Bytes

Automatic slate docs generator from files supplied into the "in" folder. Typically those files are generated as side artifacts when tests are ran, and pasted in.

This ensures that API examples:

  • are always up to date with latest tests
  • never have typos / mismatches
  • are generated programmatically, with no need for manual input

How it works:

  1. Run the tests in dbricks-server
  2. Paste the artifacts into in
  3. Run the rust binary
  4. Take the generated docs from out and paste into source/includes/out in dbricks-docs
  5. 🚀