-
Notifications
You must be signed in to change notification settings - Fork 71
Re-format for hugo docs #5489
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
Re-format for hugo docs #5489
Conversation
… this hugo-docs branch
tl;drI've pushed many more commits to this branch, primarily focused on converting as many examples as possible to the new DetailsThis branch has been wired up for months now to have its changes published to https://superdb.org/docs/, so you can see the rendering of everything touched by this PR already "live". On the whole, the
Once this PR gets merged, I plan to open some issues to point out the corner cases that we could perhaps address with some additional investment of time, and then we can come to some group "now/later/never" consensus on if we want to take action. But here's a quick overview of corner cases you may spot in this branch:
Since I effectively had to visit every example in the docs I took care of some other things along the way. Specifically I reverted much of the use of Next StepsTo me, this PR has been the main blocker on the new docs site going fully "live" (i.e., pointing to it from the top-level super repo README) since up until now tons of the examples were busted and I didn't want users seeing that. Now that's been addressed thanks to
|
Summary of changes.
In the front matter:
• sidebar_position becomes weight.
• sidebar_title becomes title.
• README becomes _index
• h1's have been removed from the markdown and rendered in the template with .Title or .Heading
If you want a different heading that what the title is, you can use the heading: key in the front matter.