spacemacs icon indicating copy to clipboard operation
spacemacs copied to clipboard

Daily tip on SpaceMacs homescreen

Open geo7 opened this issue 9 years ago • 15 comments

In chat with tuhdo and TheBB subject of a daily tip came up.

I leave gitter open a lot of the time as there is often a nice key command / function mentioned at some point that I can use. It might be nice to have something similar (non intrusively) on the homepage as well. This could (I presume) be linked to any relevant documentation.

geo7 avatar May 15 '15 09:05 geo7

@syl20bnr Prelude implemented this already, so we can use it as an example. Prelude shows the tip 5 seconds after init.

tuhdo avatar May 15 '15 09:05 tuhdo

@tuhdo are their tips fixed or can the community add to them? (with some moderation)

geo7 avatar May 15 '15 09:05 geo7

Prelude's tips are fixed. But they can add more useful ones with PR.

tuhdo avatar May 15 '15 09:05 tuhdo

This is an excellent idea. Like prelude we can take the defvar approach with a new layer variable called <layer>-tips. Then the engine should display randomly a tip for used layers only. Tips can fit nicely with the current toggles we have on the homepage.

But for this section I see a necessary dotfile variable: dotspacemacs-show-tips. The idea is that the display of the tips is only driven by this variable so we don't have to remember the toggle state of the homepage button.

In all cases a release notes that has not been viewed by the user has priority oven the display.

If I sum up the sections

  • quickhelp:
    • shown by explicit usage of the toggle button
    • not persistent accros sessions
  • tips:
    • shown by looking at the dotspacemacs-show-tips variable
    • can be toggled with the button
    • not persistent accross sessions (must use the dotfile variable)
  • release notes:
    • driven by the current spacemacs version number and stored value in .cache folder
    • can be toggled with the button
    • persistent toggle state across sessions
    • when it should be displayed it takes precedence over any other sections.

syl20bnr avatar May 15 '15 12:05 syl20bnr

If we limit the tips to only short sentences then it could be a section independent from quickhelp and release-notes. We could display the tip on top of these actions just beneath the button bar.

syl20bnr avatar May 15 '15 13:05 syl20bnr

@BrianHicks created a tips site: http://spacemacs.brianthicks.com/

I like the mini animated gif demonstration. It would be nice if <layer>-tips contained them, to be rendered inside emacs as animated gifs.

srid avatar Sep 01 '15 17:09 srid

I'm happy to record any that the community wants... probably using the official spacemacs theme, eh? ;)

FWIW I plan on going through the layers with my tips series at some point, and will probably open PRs with any that are especially illustrative, if it's something we think would be good to have.

BrianHicks avatar Sep 01 '15 18:09 BrianHicks

it would be awesome if we get the tips in a short format in the spacemacs home buffer, and with a button that says: read whole tip which takes the user to the long description of the tip and the animation (if there is one available)

CestDiego avatar Sep 01 '15 18:09 CestDiego

also consider opening new frames with a random tip instead of scratch? < make this configurable

CestDiego avatar Sep 01 '15 18:09 CestDiego

Sacha has a lot on similar topic - using org-drill for spaced repetition of emacs commands and other stuff.

https://punchagan.muse-amuse.in/posts/org-drill-for-making-it-stick.html (not sacha, but same thing)

http://sachachua.com/blog/2013/02/rediscovering-emacs-features-or-what-to-do-after-you-get-carried-away-installing-packages/

http://sachachua.com/blog/2005/01/more-emacs-evangelization-flashcard/

http://sachachua.com/blog/2016/02/building-today-learned-habit-displaying-documentation-random-emacs-commands/

tldr: make sure people will understand well contents of tips... somehow

a13ph avatar Feb 25 '16 00:02 a13ph

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Please let us know if this issue is still valid!

github-actions[bot] avatar Feb 29 '20 23:02 github-actions[bot]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Please let us know if this issue is still valid!

github-actions[bot] avatar Mar 08 '21 14:03 github-actions[bot]

I just came across this as I was googling for this functionality.... It would be really great for this to be implemented!

rommeswi avatar Mar 29 '22 12:03 rommeswi

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Please let us know if this issue is still valid!

github-actions[bot] avatar May 01 '24 16:05 github-actions[bot]

I still think this would be an incredibly useful feature. Perhaps it can be implemented in the same way as the banners?

Imo the best option would be if the tip would be based on the major mode of a random file in recentf. It can be as simple as displaying a binding. For example, if a .py file is randomly selected from recentf, the daily tip might randomly draw , r b, display the binding and the command that is run. The command has a link that opens the relevant help file.

The advantage of this approach is that it does not require the maintainer to curate a list of daily tips.

rommeswi avatar May 02 '24 02:05 rommeswi