Skip to content

Better addons documentation #577

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

Open
agjohnson opened this issue May 1, 2025 · 0 comments
Open

Better addons documentation #577

agjohnson opened this issue May 1, 2025 · 0 comments

Comments

@agjohnson
Copy link
Contributor

Right now we have a documentation project in this repository which is just release and testing information for core team. This doesn't seem super useful to maintain as a project and the content feels misplaced.

Operations information should be in our ops playbook docs and testing/development info doesn't really require a whole documentation project. This could be in the readme or our development playbook docs, but the content in the readme here is mostly replicating the marketing content that we're maintaining in our application docs.

The documentation our users need from us is instead deeper information on our API, events triggered, and CSS customization. We have some examples and a basic list at:

https://docs.readthedocs.com/platform/stable/addons.html

But it is cumbersome and disconnected to have to document this level of detail in another repository. Especially because we benefit on the development side from documentation in source files.

What I'm describing is:

  • Move operations documentation for core team to our operations playbook docs
  • Keep the readme just information needed to work with the repository
  • Move/keep marketing content in our application documentation and website for now -- screenshots/etc
  • Thoroughly document the library API, events, and CSS customization here. Use Sphinx (and probably JSDoc and autoanysrc for CSS) to document at the source files.
  • Use this project as a subproject on our main docs project, https://docs.readthedocs.com/addons/
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

No branches or pull requests

1 participant