Create a Markdown Text Entity of Arbitrary Size

[ttreker]

The Idea

Create an entity that can store arbitrary markdown text for documentation purposes. The reason for this is that there is no great way to document projects inline with automation systems one is building or store and categorize notes on nuances of configurations. If such an object existed then one could use it to document a project. Using labels one could label all entities including the standard Automations, Scenes, Scripts and Helpers as well as Todo lists along with these documenting markdown entities to consolidate everything related to one single system that one is developing or has developed. Labels would allow these items to be applied across projects.

The Motivation

I never remember why I did things. The only place to document things is to put descriptions in individual automations or create a view that has markdown cards (which is what I do now; these are very awkward to maintain!).

Further Thoughts

With such an entity one could then create a view for a project on which one could add buttons with navigation links to specific labels that were used to tag projects.

Thinking more expansively another feature could be created where there might be a sub view type maybe called 'Project' whereby one just specifies a label and it provides an organized presentation of all the differing types of items related to project where the items have been labeled. Clicking on a Markdown entity would bring up a view or editor.

The general idea here is that projects need documentation. Right now labels can be leveraged to consolidate most items related to a project even including todo lists. There is no non-awkward way to document a project.

A Use Case Providing More Food For Thought on this Topic

Let's say someone wants to embark on a complicated 'automation' involving many differing automation aspects e.g. Helpers, Scripts, Automations, etc. some that are preexisting and some that will be built. A workflow as follows might be nice:

1. Create a project view or even entity.
2. Tie this project to a label.
3. Create some documentation entities outlining specifications and label them with this projects label.
4. Create todo lists and label them with the project label.
5. Select preexisting Scripts, Helpers, etc. and again label them as above.
6. Create new entities (Automations, Scripts, etc.) labeled again as above.

Now one has one-stop shopping to get to everything related to the system one is developing or has developed in order to refine or expand it.

Such a system would really firm up the ability to develop complex systems while keeping track of their components, configuration quirks and nuances, and design choices.

I have to tell you I really wish that this existed a long time ago. I would have done a lot more HA development if it had.