helpers icon indicating copy to clipboard operation
helpers copied to clipboard

Document the documentation toolchain

Open gpsaggese opened this issue 7 months ago • 2 comments

We want to document the little tool chain we have written

  • Read some of the docs here https://github.com/causify-ai/helpers/tree/master/docs/documentation_meta

    • [x] @indrayudd
    • [ ] @aver81
  • Run notes_to_pdf.py (look at the unit tests) ./helpers_root/dev_scripts_helpers/documentation/test/test_notes_to_pdf.py

    • [x] @indrayudd
    • [ ] @aver81
  • Specs are here https://docs.google.com/document/d/1wvbtto8glYQpQMCc4b7fun-xRTwQMgMcKNE9vTETx88/edit?tab=t.1ld45ctu8mwg#heading=h.qvuh6anubz9y

You can split the work in any way you want.

gpsaggese avatar May 20 '25 16:05 gpsaggese

Let's add some notes on the

  • Use - for bullets
  • Do not use tables unless necessary (they are too difficult to maintain)
  • No --- to separate stuff

gpsaggese avatar May 28 '25 22:05 gpsaggese

The content was good, we need to:

  1. create a template for how we document things (GP has put together one)
  2. use LLMs to do cosmetic transforms + apply the template to a markdown

Let's follow up with https://github.com/causify-ai/helpers/issues/702

gpsaggese avatar May 30 '25 17:05 gpsaggese