Announcements: update logic to always show one if possible
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 25/100
Research direction
Start by reviewing the dashboard announcement templates and the linked pull request discussion about issue 377. Determine whether dismissed announcements should be handled through template-side cookie logic or by displaying all announcements and letting Knockout decide; done means the dashboard shows the next undismissed announcement whenever one is available.
Written by the indexing model from the issue text.
Description
For dashboard announcements, we allow the user to hide an announcement. However, because the decision on which announcement to display is done by the templates, there is no way for the front end to back down to an announcement that the user hasn't dismissed.
To solve this, and always show an announcement to the user, we need to either:
- Make the back end aware of dismissed announcements and show the next announcement in our onboarding progression to the user. This would likely be something like using a cookie in the template decision.
- Push the decision on which onboarding announcement to show partially/entirely to the front end display. This would likely be writing announcements in templates still, but displaying all announcements and using KO to decide which to show.
https://github.com/readthedocs/ext-theme/pull/377#issuecomment-2161270462
- Dominant language
- HTML
- Stars
- 12
- Forks
- 6
- Avg merge
- 13h 25m
- Merged PRs (30d)
- 1
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from readthedocs/ext-theme
-
Bug
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
readthedocs/ext-theme#756 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 65/100
readthedocs/ext-theme#742 · 1 comment ·
-
Improvement
Difficulty 3/5 1-2 days Newbie friendliness 45/100
readthedocs/ext-theme#736 · 4 comments · 1 reaction ·
-
Improvement
readthedocs/ext-theme#714 · 4 comments · 1 assignee ·
-
Improvement
Difficulty 3/5 1-2 days Newbie friendliness 52/100
readthedocs/ext-theme#713 ·
All issues in readthedocs/ext-theme
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
-
code-quality refactoring
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
github/gh-aw-firewall#8816 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
getgrav/grav-plugin-api#45 ·
-
integration:quickjs org:external priority:backlog topic:code-interpreter topic:middleware type:feature
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
langchain-ai/deepagents#6450 ·