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

Move Docs as Code -> Addons, and update Docs as Code #279

Merged
merged 22 commits into from
Apr 25, 2024
Merged

Conversation

ericholscher
Copy link
Member

@ericholscher ericholscher commented Apr 3, 2024

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

📚 Documentation preview 📚: https://readthedocs-about--279.org.readthedocs.build/

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
@ericholscher ericholscher requested a review from a team as a code owner April 3, 2024 15:55
@ericholscher ericholscher requested a review from agjohnson April 3, 2024 15:55
content/pages/addons.html Outdated Show resolved Hide resolved
content/pages/addons.html Outdated Show resolved Hide resolved
content/pages/addons.html Outdated Show resolved Hide resolved
content/pages/addons.html Outdated Show resolved Hide resolved
content/pages/addons.html Outdated Show resolved Hide resolved
content/pages/addons.html Outdated Show resolved Hide resolved
content/pages/addons.html Outdated Show resolved Hide resolved
Comment on lines 242 to 244
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.
Copy link
Member

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.

Copy link
Contributor

@agjohnson agjohnson left a 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.

content/pages/addons.html Outdated Show resolved Hide resolved
content/pages/addons.html Outdated Show resolved Hide resolved
content/pages/addons.html Outdated Show resolved Hide resolved
content/pages/addons.html Outdated Show resolved Hide resolved
content/pages/addons.html Outdated Show resolved Hide resolved
content/pages/addons.html Outdated Show resolved Hide resolved
content/pages/addons.html Outdated Show resolved Hide resolved
content/pages/docs-as-code.html Outdated Show resolved Hide resolved
@ericholscher ericholscher requested a review from a team as a code owner April 24, 2024 15:26
@ericholscher ericholscher requested a review from agjohnson April 24, 2024 15:26
@ericholscher ericholscher self-assigned this Apr 24, 2024
@ericholscher
Copy link
Member Author

This is ready for another round of review.

Copy link
Member

@humitos humitos left a 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 👍🏼

content/images/docs-as-code/flyout-zoomed.png Outdated Show resolved Hide resolved
content/pages/docs-as-code.html Show resolved Hide resolved
Copy link
Member

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.

Copy link
Member Author

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.

content/pages/docs-as-code.html Outdated Show resolved Hide resolved
content/pages/docs-as-code.html Outdated Show resolved Hide resolved
content/pages/features/reader.html Show resolved Hide resolved
content/pages/features/reader.html Show resolved Hide resolved
content/pages/features/reader.html Show resolved Hide resolved
content/pages/features/reader.html Show resolved Hide resolved
{%- set icon_1 = "fa-chart-mixed" -%}
<a href="#analytics" class="ui small teal header item">
{%- set header_1 = "Versioning" %}
{%- set slug_1 = "versioning" %}
Copy link
Member Author

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

@ericholscher ericholscher enabled auto-merge (squash) April 25, 2024 16:06
@ericholscher ericholscher merged commit f3397d5 into main Apr 25, 2024
3 of 4 checks passed
@ericholscher ericholscher deleted the addons-swap branch April 25, 2024 16:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants