helpers
helpers copied to clipboard
Document the documentation toolchain
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.
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
The content was good, we need to:
- create a template for how we document things (GP has put together one)
- 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