Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve docs discoverability #382

Open
hancush opened this issue Sep 24, 2024 · 4 comments
Open

Improve docs discoverability #382

hancush opened this issue Sep 24, 2024 · 4 comments
Assignees

Comments

@hancush
Copy link
Member

hancush commented Sep 24, 2024

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
Copy link
Contributor

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

@xmedr
Copy link
Contributor

xmedr commented Nov 14, 2024

@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
Copy link
Member Author

hancush commented Nov 14, 2024

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

@xmedr
Copy link
Contributor

xmedr commented Nov 14, 2024

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants