datamade / how-to

📚 Doing all sorts of things, the DataMade way
MIT License
89 stars 12 forks source link

Improve docs discoverability #382

Open hancush opened 2 months ago

hancush commented 2 months ago

Lately, there have been several instances of rehashing approaches we have documented, because the relevant docs were buried (organized un-intutively, and/or not added to the table of contents in the root of this repo) and the instinct the check them isn't fully engrained (which are likely related phenomena).

I had a very good experience standing up docs for the Metro scrapers in Quarto (#334), which among many other nice things has automatically updating tables of contents and built-in search. I'd like to propose migrating written documentation to a Quarto site deployed on GitHub pages and, as part of that effort, pruning and reorganizing our docs in a way that makes more logical sense.

antidipyramid commented 1 month ago

@hancush mentions that cookiecutters should be separated from how-to documentation.

xmedr commented 1 week ago

@hancush While migrating docs over to quarto, I found that within the CI folder there's some documented proposals for using github actions and codedeploy. Do we have any objections to moving things like that out of their folders and into an organized "Archived" section? Or does it make more sense to just keep them in there?

hancush commented 1 week ago

@xmedr The docs need pruning and reorganizing broadly. Happy to hear a proposal, if you want to make one?

xmedr commented 1 week ago

Ya for sure, I'll keep going through and see what else comes up!