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

docs: change docs rendering and split up markdown files #290

Merged
merged 1 commit into from
Aug 4, 2023

Conversation

ArcaTech
Copy link
Contributor

@ArcaTech ArcaTech commented Aug 2, 2023

Closes #222

Notes:

  • Split the markdown files into folders for each section (I numbered them since I didn't know how else to dynamically show them in order)
  • Added a nav Lume component. I was thinking about making the sections collapsible, but I didn't want to introduce something complicated for state so I just kept all the behavior the way it was. But adding some interactivity in the future will be a little easier with the component.
  • The header() function in the docs template doesn't feel good enough. I wanted to do something with a list of urls/titles that can be referenced for the header and nav, but I thought it was better to get this out sooner/simpler and let you decide if you want it improved right now.
  • There's some duplication going on with the index.tsx files in each of the docs directories. I tried to make those pages/components as small as possible at least, but it will be nice to figure out a way to clean up the extra files.

@progrium progrium merged commit c4441f6 into treehousedev:main Aug 4, 2023
@taramk
Copy link
Contributor

taramk commented Aug 4, 2023

@progrium @ArcaTech so for the user guide homepage (https://treehouse.sh/docs/user/), is it possible to put something custom there (like section cards or something) rather than the full user guide text? i can implement it.

@ArcaTech
Copy link
Contributor Author

ArcaTech commented Aug 4, 2023

Yup. Each of the directories in web/docs (dev, project, quickstart, user) has an index.tsx that displays that section. Right now, each one of those files has the same code that collects every page underneath it and displays them, but you can replace that directly with any HTML you want.

This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Auto-generate top-level nav in docs AND split up user guide contents into separate pages
3 participants