Sorry, we don't support your browser.  Install a modern browser

Allow builders to embed comments to themselves on workflow pages.#262

L

When coding in other applications, developers can often use the double // to make comments that do not affect the code. These comments can be helpful in explaining why certain variables exist, why you need invisible logic to accomplish a task, could include external links to helpful resources (such as a gavel resource page), could mark incomplete implementations, or document ideas that haven’t been fully developed yet.

These comments would not be seen by the end user.

Perhaps it could be a new type found in the Information Block area. So there could be 3 choices: Instruction, Kickout Page, Builder Comment

2 years ago
1

Great point, Lorrie. I wonder if you could accomplish this by creating an Instruction block in Gavel that has a condition set so that it never appears when you run the workflow? Or would you want it to also appear when you run the workflow?

2 years ago
L

No, it doesn’t need to appear when running. I thought about a conditional instruction block as well, but thought I would throw this in. I thought for the beginning builder, having a “comment” type would be more obvious, in case they hadnt ever thought about recording their notes that way.

2 years ago

Makes a lot of sense. I agree. Thank you for explaining!

2 years ago