Modules & Targets information

[Wingnut]

I suggest that we show the list of targets and modules in the about box (it may optionally be seen in other suitable places e.g. an optional splash screen). There could be a json or xml that you fill in short name and short description in each module and target which will be showed.

 

[MikeHart]

Why?

 

[Wingnut]

It's nice to know when you start the app what possibilities you have. Right now the only way to know, is to look inside two folders very carefully. And to know what platforms they support you need to read separate documents or dive deeper into folders.

Each extension could have a graphical icon as png or svg related to them, and all extensions could write Android, iOS, Web support etc, or just list the icons after the extension.

This is something old BASICs had and to me it makes sense to me if you want a plugin culture.

 

[Wingnut]

This list could also be a good place to have hyperlinks to the actual plugin-documentations. Wiring it together with the main docs.

 

[MikeHart]

Well.... if more people would have a use for it, it could be done for TED, but then it is a dying breed. You wouldn't be able to add this to VSCode. And then, this could only be done for the official distribution and its modules. We would not be able to force others to update their modules.

Second it is redundant. This info should be in the docs for each module and mostly is.

Cerberus X Documentation

But maybe you mean something else.

 

[MikeHart]

Maybe you can make a concept how it could look like? You mean a popup when you start TED?

 

[Wingnut]

I'm totally with you, let's forget about TED. Oh yes the autodocumentation, I forgot about that. Okay I of course trust the documentation system is gonna be able to deal with the main parts of this, but I have an idea in my head but I'll waitl and see how the VStudio add will work first, and
if still there is a need I can absolutely draw some concepts.

 

[MikeHart]

VStudio add will work first, and
if still there is a need I can absolutely draw some concepts.

I think it is kinda the same, as it takes the created docs. So, go ahead and create a mockup.

This is something old BASICs had

Do you have links to the BASICs you mentioned where their editors had this functionality?

 

[Wingnut]

Most of those languages are forgotten. But I think many remembers STOS and AMOS BASIC on the Atari & Commodore Amiga. They start with a simple list of addons which tells you quickly what addons they have and what versions they're at if important. They had 3D, and compiler, different big nummber libraries, tile systems, improved implementation of graphics commands with better speed etc.

That's just the gist of what inspired me. Maybe we could do better. Having a great documentation system that presents everything in a slim and simple is a great start.

 

[Phil7]

Right now the only way to know, is to look inside two folders very carefully. And to know what platforms they support you need to read separate documents or dive deeper into folders.

Each extension could have a graphical icon as png or svg related to them, and all extensions could write Android, iOS, Web support etc, or just list the icons after the extension.

You know about this page of the documentation? This is the link to the new docs and there it is called "Basic Modules". But it was in the menu of the old docs as "API Reference". I think I will make it more compact, so you can have an overview without scrolling.

 

[Wingnut]

Thanks!