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

Announcement: allow users to publish notes on their docs #109

Closed
humitos opened this issue Sep 5, 2023 · 2 comments
Closed

Announcement: allow users to publish notes on their docs #109

humitos opened this issue Sep 5, 2023 · 2 comments
Labels
Feature New feature Needed: design decision A core team decision is required

Comments

@humitos
Copy link
Member

humitos commented Sep 5, 2023

I remember talking to someone from the core team about exposing the ability to make "announcements" to project maintainers on their documentation. I'm thinking about something similar to what Webpack documentation is doing.

Screenshot_2023-09-05_21-40-40

The "announcement addons" could be used to publish news or similar in all the pages of the project's documentation. I haven't thought too much about this and the idea could be expanded after some brainstorming, but I think it has potential. Definitely, pretty useful if you want to add these announcements to old versions without rebuilding them. Users should be able to configuration the "versions affected" and also the "message" to show.

Live example: https://webpack.js.org/concepts/

@humitos humitos added Feature New feature Needed: design decision A core team decision is required labels Sep 5, 2023
humitos added a commit that referenced this issue Sep 9, 2023
It allows users to show a small announcement at the bottom-left of the page.
The message and on which versions to show it are configurable.

Closes #109
humitos added a commit that referenced this issue Sep 9, 2023
It allows users to show a small announcement at the bottom-left of the page.
The message and on which versions to show it are configurable.

Closes #109
@humitos
Copy link
Member Author

humitos commented Nov 28, 2023

There is some ideas we can get from this Material for MkDocs conversation squidfunk/mkdocs-material#5803

@humitos
Copy link
Member Author

humitos commented Nov 14, 2024

This could now be implemented by the user itself using the CustomScript addon: readthedocs/readthedocs.org#11758

@humitos humitos closed this as completed Nov 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature New feature Needed: design decision A core team decision is required
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant