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

Add Addons customization docs #11888

Merged
merged 11 commits into from
Jan 13, 2025
Merged

Add Addons customization docs #11888

merged 11 commits into from
Jan 13, 2025

Conversation

ericholscher
Copy link
Member

@ericholscher ericholscher commented Jan 7, 2025

This is start for this work,
and mostly just pulls examples from the Mkdocs page over to the Addons docs.

I think there's more to do here with examples,
but I think this is a reasonable starting point.


📚 Documentation previews 📚

This is start for this work,
and mostly just pulls examples from the Mkdocs page over to the Addons docs.

I think there's more to do here with examples,
but I think this is a reasonable starting point.
@ericholscher ericholscher requested a review from a team as a code owner January 7, 2025 22:37
@ericholscher ericholscher requested a review from agjohnson January 7, 2025 22:37
@ericholscher ericholscher requested a review from humitos January 7, 2025 22:59
@humitos
Copy link
Member

humitos commented Jan 8, 2025

I would not document the CSS variables yet since we are having a discussion about that in readthedocs/addons#473 and we are thinking about removing support for them for now while we explore how to it in a reliable way.

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. There are a few pending decisions we may want to decide before merging; but other than that, looks like a good first step.

docs/user/addons.rst Show resolved Hide resolved
docs/user/addons.rst Show resolved Hide resolved
Comment on lines 87 to 88
- ``--readthedocs-flyout-dd-font-size``
- ``--readthedocs-flyout-dt-font-size``
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@agjohnson mentioned these dd- where not necessary in readthedocs/addons#488 (comment), so I'm not sure if he is planning to remove them.

docs/user/addons.rst Outdated Show resolved Hide resolved
docs/user/addons.rst Show resolved Hide resolved
@ericholscher
Copy link
Member Author

@humitos I can remove the CSS variable reference if we aren't ready to fully list them out? I'd like to get at least the custom event stuff unblocked here if possible.

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.

This looks good. I think there are benefits to authoring this type of documentation in the addons docs, and not a whole lot of benefit to authoring in our application docs. Not important for now, but it's something we should consider more.

docs/user/addons.rst Show resolved Hide resolved
docs/user/addons.rst Outdated Show resolved Hide resolved
docs/user/addons.rst Show resolved Hide resolved
docs/user/addons.rst Outdated Show resolved Hide resolved
docs/user/addons.rst Outdated Show resolved Hide resolved
docs/user/addons.rst Outdated Show resolved Hide resolved
* ``versions.current`` - Details about the current version
* ``versions.active`` - List of all active and not hidden versions

.. dropdown:: Click to see an example of the Addons data
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is another example of documenting this in Addons docs being less work. We have the mock API data in the Addons repo that we keep up to date for testing, this would be better than replicating this data to this repo and it going out of date.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yea, there's a bunch of room for improvement here, but getting something documented is more important than doing a bunch of infra work to publish the same stuff in another fashion.

docs/user/addons.rst Show resolved Hide resolved
docs/user/addons.rst Outdated Show resolved Hide resolved
docs/user/addons.rst Outdated Show resolved Hide resolved
ericholscher and others added 2 commits January 13, 2025 14:34
@ericholscher ericholscher enabled auto-merge (squash) January 13, 2025 22:44
@ericholscher ericholscher merged commit e7afae1 into main Jan 13, 2025
5 checks passed
@ericholscher ericholscher deleted the custom-event-docs branch January 13, 2025 22:50
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.

3 participants