<@U06A03HV1> <@U051221NF> <@U021C96KUGJ> rewrite o...
# developmenth
hundreds-father-404
06/06/2022, 8:36 PM@witty-crayon-22786 @happy-kitchen-89482 @ancient-vegetable-10556 rewrite of the docs proposal. Now proposing Sphinx as some possible future followup. For now, it's only saving Readme.com in-repo
hundreds-father-404
06/06/2022, 8:36 PMAnd it looks like Readme's new markdown editor has gotten nicer. I'm less terrified about how awkward this will be do to do
hundreds-father-404
06/06/2022, 8:36 PMhundreds-father-404
06/06/2022, 8:37 PMI can get started on this now if we have consensus? Seems like a fairly small project thanks to
generate_docs.pyhundreds-father-404
06/06/2022, 8:37 PMOpen question if we want to backport this change to 2.11 and 2.12. Given that I tbh haven't finished the 2.11 docs audit, I would like to backport. I'd like to copy the docs exactly as is, then finish the audit with code review from y'all.
b
bitter-ability-32190
06/06/2022, 8:39 PMCan you attach a PoC branch of what the filetree would look like?
Is that easy?
h
hundreds-father-404
06/06/2022, 8:41 PMI still have to design what file organization makes sense -- but we have total control over it
Given that in-repo Readme.com cannot leverage the DRY benefits—where one docs snippet is used on multiple pages—I was thinking we use a very simplistic layout.
\> chapter, e.g. Python
-- > top-level page/folder
-- > subpage
w
witty-crayon-22786
06/06/2022, 10:04 PMthanks: this sounds great. will take a look this afternoon.
❤️ 1
witty-crayon-22786
06/06/2022, 11:45 PMlooks great, thanks! my largest comment is just that i still think it would be good to write up a blurb of convention to help contributors/maintainers known when to encourage one another to make edits.
or perhaps that is the first reviewed doc edit =P
👍 1
h
happy-kitchen-89482
06/07/2022, 3:15 PMLooks great! I commented with some issues that we'll need to address at some point, if not necessarily now.