Alright, my goal with this.
I recently thought of the idea to make something out of my ID references you can find in my shortcut topic. The idea is pretty much documentation of blocks kind of like a wiki.
This is the concept I have so far, with the block list on the right and details of the selected block on the main page.
There’s a lot of potential information with each one, and this would be too big of a project for any one person to handle, especially with a busy schedule like mine.
I have all of the blocks currently in Hopscotch right now (normal, secret, beta editor, etc.), but barely started the information for each one. You can see the various types of parameters, sections, and colors of the blocks. So far, I’m only including editor blocks, not math operators, custom rules, etc. though I might consider that later.
So far, the information I have for each one include:
- Basic Description: A very shot phrase about the general idea of this block.
- All of the Block’s Parameters: Detailed explanation of each parameter, its function, and its type.
- What is the Block Useful for? This will encourage users to experiment and use each type of block more, for the most part at least.
- The Hopscotch Description, it’s a good thing to include
- Methods of Obtaining the Block
- The ID Number of Each Block (where I got the idea for this)
- If possible, the version of Hopscotch or the month that the block was first seen in.
- Projects that demonstrate good use of this block, that way users can get an interactive example of them. Projects should be simple and easy to understand for the most part. I prefer projects that demonstrate a good concept or is worthy of curation.
- Tutorials with the block – a good extension of grasping understanding or getting more ideas of how to use it.
When we get enough information, I’ll probably add this onto codepen (or github if my account would work with my circumstances) for all of you to access and refer newcomers to.
Let’s start by suggesting possible things to add to each block’s information, then we’ll get started with data collection.
Contributors get their names credited on every page they contribute to, as well as ePoints for every bit of information that they contribute.
- I am interested in helping, please tag me for all updates
- I want to be tagged for occasional updates
- cool idea bro
I will tag all contributors later, so please vote in the poll if you’d like to help. There is no commitment requirement, so if you are busy but would still like to contribute, don’t hesitate to!
Let’s do this!
You can find the latest version of the page here at any time.