chaosphere2112
commented
9 years ago Notions:
- Django vs Hyde
- Django:
- Easy to perform mechanical actions on
- Lots of dynamism
- Hyde:
- Easy to maintain
- Easy to version
- Easy to contribute
- Blended approach:
- Bulk of documentation in hyde...
- Need to anchor headers
- Maybe need a good anchoring system in general?
- Some syntax for anchoring instead of relying on hyde.
- ToC in Django
- Process anchors, generate ToC
- Code tags -> reference generated in Django?
- All code tags will link to the referenced item?
- JavaScript? So we don't have to deal with too much django/hyde interfacing?
- Easy maintenance; as the text docs get updated, the giant table will too.
- Cheat sheet generation
- PDF generation
- Can use the HydeFinder to get all of the files, then process them
- Example Validation
- Track examples in the DB (any
blocks?), and have them runnable in some fashion to check if they throw any exceptions?
- Track examples in the DB (any
- Gallery
- All documentation examples should be in the gallery
- "Run Example" button that just spits out the result?
- Change it so gallery can be filtered by a lot more things.
- "VCS", "CDMS2", "Utilities"...
- Make UI zippier
- Auto-generate thumbnails when images are uploaded
- Code block output / Image output options
- Link into the gallery from the documentation, into the documentation from the gallery
Separate documentation into its own repo/django app, serve from here