Documentation plans?


#1

Are there any plans in the future for searchable documentation for Stimulus?

I would be interested in contributing if there is.


#2

We don’t have a search field for the Handbook right now, but you can use Google’s site: operator to find something specific: https://www.google.com/search?q=site%3Astimulusjs.org%2Fhandbook


#3

I have started my own cheatsheet of sorts for Stimulus dev, have a look at it and let me know what you think: https://gist.github.com/mrmartineau/a4b7dfc22dc8312f521b42bb3c9a7c1e

If you have any thoughts, please let me know.


#4

Great start, wanted to do one too but yours will be perfect for my need…

If I could suggest an improvement: add a section about conventions
you could use this table from @sam


Whenever I explain Stimulus to someone I always refer to this table at some point to explain the naming conventions and I think it is something really lacking in the current documentation.


#5

Great work @mrmartineau, that’s exactly what I was looking for.

I’ve created a fork which also includes information about multiple targets and multiple actions on a single element.

I also did what @adrienpoly suggested and included the naming convention table.


#6

Thanks for that @scottharvey, I have also updated mine to include your additions and some other minor amendments.