Snippets cheatsheet

[hhkaos]

What do you feel about making a printable version like this:

Right now, the table in the readme doesn't look very friendly to me. I would probably organize by categories like: basics, core, geometry, layers, renderers, popup, smartmapping, ... maybe even grouping using some color to differentiate those snippets only for 2D or 3D elements from the common ones.

If you think it might be worthy I don't mind making the first sketch in a collaborative tool like Google Drawing on which we can iterate.

[kellyhutchins]

@hhkaos I think that looks great and agree that we could organize by category.

[hhkaos]

I'm not sure which tool to use, I also found cheatography.com, I'll try to find some time this week to start a draft 😄

[hhkaos]

Finally, I have found some time to start with Google Drawings (for now), you can access and edit it here:

I think it could make sense to make different cheatsheets, one for 2D, another one for 3D, Typescript, etc. Otherwise, it is going to be very large and I guess a developer won't need all of them.

What do you think?

[hhkaos]

After adding new snippets on my local environment I have decided to use cheatography.com (it also allows collaborators). This is how it looks with my new snippets:

[kellyhutchins]

Looks great! I think this will make the snippets much easier to discover and use.

[hhkaos]

UPDATE 26/10/2023 > (created new issue)
I'm thinking if it would be easy/possible to use Calcite Design System to automatically generate/update the cheat sheet... I don't see an easy way but it would be nice. Another option would be to release a new version of the extension (and update the cheatsheet simultaneously) one or two times per year.

Said that, I think we could plan a v2.0 release of the extension for... September? and public the first official version of the cheat sheet. What do you think?

[kellyhutchins]

I think the September date sounds good and yes if we could auto-generate the cheat sheet that would be great but until we figure out a way to do that I think updating the cheat sheet when we add new snippets won't be a huge problem.