-
Notifications
You must be signed in to change notification settings - Fork 6
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
Move Docs as Code -> Addons, and update Docs as Code #279
Conversation
This is the start of a reader features / addons page, and a small update to the docs as code page. TODO: * Update images on Docs as Code page * Work on copy
content/pages/addons.html
Outdated
All these features will be enabled by default when using the | ||
[``build.commands``](https://docs.readthedocs.io/en/latest/config-file/v2.html#build-commands) | ||
config key as shown in the example. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should eventually link to the blog post I'm writing at #278 that says how to enable addons properly.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Overall, this seems like it's somewhere in between an feature page for reader features and a description of Addons. We do need both, so could either focus on just describing Addons features, or just describe reader features so we can break out feature pages for the navigation changes.
This is ready for another round of review. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me! I left some suggestions 👍🏼
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd use an image of the "Downloads" section from our own flyout over a Docusaurus project, so it keeps consistency with the rest of the images.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's in the next image, which seemed a bit odd. I wanted to have one that's integrated into the docs, which seemed nicer.
{%- set icon_1 = "fa-chart-mixed" -%} | ||
<a href="#analytics" class="ui small teal header item"> | ||
{%- set header_1 = "Versioning" %} | ||
{%- set slug_1 = "versioning" %} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Wish pelican has a slugify function
Co-authored-by: Manuel Kaufmann <[email protected]>
This is the start of a reader features / addons page,
and a small update to the docs as code page.
TODO:
📚 Documentation preview 📚: https://readthedocs-about--279.org.readthedocs.build/