Docs: Add documentation for CustomScript addon (#12623)
- [x] Understand the existing addons documentation structure
- [x] Review the CustomScript addon feature implementation and usage
- [x] Create documentation for the CustomScript addon in dedicated
`docs/user/custom-script.rst` file
- [x] Document the `window.ReadTheDocsEventData` flag for accessing
addons data
- [x] Add information about contacting support to enable the feature
- [x] Include an example of how to use this feature
- [x] Build and verify the documentation renders correctly
- [x] Run code review on documentation changes
- [x] Run security scanning (no code changes detected)
- [x] Address PR feedback: add Custom Script to initial features list in
`addons.rst`
- [x] Address PR feedback: update code comments for better clarity
- [x] Address PR feedback: move Custom Script documentation to separate
file following addon documentation pattern
<!-- START COPILOT CODING AGENT SUFFIX -->
<details>
<summary>Original prompt</summary>
>
> ----
>
> *This section details on the original issue you should resolve*
>
> <issue_title>Addons: add documentation for
`CustomScript`</issue_title>
> <issue_description>We need to document this addon and put some
examples on how to solve common issues with this feature.
>
> * Refs: https://github.com/readthedocs/readthedocs.org/pull/11758
> * Requires:
https://github.com/readthedocs/readthedocs.org/issues/11774
> * Requires: https://github.com/readthedocs/ext-theme/issues/527
> * Requires:
https://github.com/readthedocs/addons/pull/474</issue_description>
>
> <agent_instructions>We want to document this feature, even it's not
exposed in the UI. Tell people to contact support if they want to make
usage of this feature.
>
> Explain the flag we expose in `window` object.
>
> Mention an example of what this feature is useful
for.</agent_instructions>
>
> ## Comments on the Issue (you are @copilot in this section)
>
> <comments>
> <comment_new><author>@ericholscher</author><body>
> We actually aren't exposing this to users -- should we, and write docs
for it? </body></comment_new>
> <comment_new><author>@humitos</author><body>
> Yeah. I think it's fine to have small docs for this addon. It's not
polished/perfect, but it's useful. We can add the other features
mentioned in the description of the issue in the following iteration
when more people are using it and requesting for
upgrades.</body></comment_new>
> </comments>
>
</details>
- Fixes readthedocs/readthedocs.org#11775
<!-- START COPILOT CODING AGENT TIPS -->
---
💡 You can make Copilot smarter by setting up custom instructions,
customizing its development environment and configuring Model Context
Protocol (MCP) servers. Learn more [Copilot coding agent
tips](https://gh.io/copilot-coding-agent-tips) in the docs.
---------
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: humitos <244656+humitos@users.noreply.github.com>
Co-authored-by: ericholscher <25510+ericholscher@users.noreply.github.com>
Co-authored-by: Manuel Kaufmann <humitos@gmail.com>
