Quick question for anyone interested in UIBUILDER for Node-RED.
Is it useful to you to have UIBUILDER's documentation available offline?
- It is useful to have UIBUILDER's Documentation available offline
- It isn't really useful
Currently (up to v7.2.0 at least), UIBUILDER's documentation is included as part of the package. Therefore, once you've installed the uibuilder package, you can use the documentation even if you don't have an Internet connection.
I've always assumed that some might find that helpful. However, as UIBUILDER has matured over the years, so the documentation has grown. I'm now finding that the way it is provided right now is becoming a bit limited and I'm wondering if it wouldn't be better to move it to a separate Internet web site.
So, that's the question. Let me know if you are keen to keep offline documentation because I expect that otherwise, a future version will see it moved.
Advantages for the current way
- All documentation is available without an Internet connection (as well as online via GitHub pages).
Disadvantages of the current way
- It uses
Docsifywhich dynamically turns Markdown into HTML. This can be relatively slow, especially as the documentation grows. - It is imposing some technical constraints on the content, its layout and formatting.
- It limits the online version of the documentation to a single version which isn't always quite in step with the released version of UIBUILDER.
- No easy way to allow comments/feedback on the current documentation.
- Makes the uibuilder package size a lot larger.
If the documentation is moved, it will go to its own sub-domain of totallyinformation.net similar to the documentation for my web components. But it will almost certainly be changed to use Astro like my new Blog. This would allow a lot more flexibility, allow comments, etc.
