[WIP] Update documentation for Timer Mocks

[sigveio]

Summary

The Timer Mocks guide in the documentation is currently out of date with examples based on the old legacy timers. Very few of the examples work anymore, and this seems to generate quite a few bug reports and support requests in the issue tracker and across various other channels.

My goal with this PR is to bring it up to date, and also change the structure slightly to drive home some of the more important points early on.

The PR contains some minor tweaks to the website to accommodate this:

• CSS for supporting line highlighting in docusaurus
• CSS to darken the background color of Note style admonitions in dark mode, as it used a very bright grey.

Preview

A preview is available here. Feedback is welcome :-)

Todo

Please note that this is a "work in progress"

• Basic structure
• Code example for enabling fake timers
• Code example for recursive timers
• Code example for advancing by time
• Code example for stepping through timers
• Move examples/timer -> examples/timer/legacy
• Add new code examples under examples/timer/modern
• Add F.A.Q.s -- Suggestions, anyone?
• Consider tweaking colors of highlighting and 'Note' admonition
• Fine tune the language

Test plan

n/a

Supersedes #11324, #10964, #10022
Closes #11713

[codecov-commenter]

Codecov Report

Merging #11731 (cbe8143) into master (98f10e6) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master   #11731   +/-   ##
=======================================
  Coverage   69.04%   69.04%           
=======================================
  Files         312      312           
  Lines       16366    16366           
  Branches     4746     4746           
=======================================
  Hits        11300    11300           
  Misses       5039     5039           
  Partials       27       27           

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 98f10e6...cbe8143. Read the comment docs.

[SimenB]

(sorry, misclicked)

The PR contains some minor tweaks to the website to accommodate this:

• CSS for supporting line highlighting in docusaurus
• CSS to darken the background color of Note style admonitions in dark mode, as it used a very bright grey.

Could you separate those out into another PR so this one can be just the changed text?

[sigveio]

Could you separate those out into another PR so this one can be just the changed text?

Yep, can do; I just thought it would make sense to keep them here while it's a draft so that it can be previewed together. Since afaik line highlighting or the admonition in question aren't used elsewhere so far. I would suggest that I cherry pick these out when the PR is all tied up and ready.

I also noticed today that my F.A.Q. answer is inaccurate; since it's still possible to spy on the global yourself. So I will adjust that and try to think of another way to encourage the point I was trying to make re: decoupling from implementation details

[SimenB]

Lost track of this, sorry @sigveio! I really like these changes, would you be interested in reviving this PR?

[sigveio]

No worries, @SimenB - and sorry for not following up myself lately. If this is still needed I can try and pick the ball back up. :-) Very happy to see that you also continued work on #11778 while I was AWOL. Thanks! ❤️

[github-actions]

This PR is stale because it has been open 1 year with no activity. Remove stale label or comment or this will be closed in 30 days.

[github-actions]

This PR was closed because it has been stalled for 30 days with no activity. Please open a new PR if the issue is still relevant, linking to this one.

[github-actions]

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.
Please note this issue tracker is not a help forum. We recommend using StackOverflow or our discord channel for questions.