feenkcom / gtoolkit

Glamorous Toolkit is the Moldable Development environment. It empowers you to make systems explainable through experiences tailored for each problem.
https://gtoolkit.com
MIT License
1.08k stars 47 forks source link

Add LepiterDB Views to BaselineOf & packages from a repo #2658

Open botwhytho opened 2 years ago

botwhytho commented 2 years ago

Class comments being limited to only one page are a bit limited. There is currently no way to easily surface Lepiter DBs that come with packages you load into your image. If end users can't easily consume package-specific DBs this doesn't encourage package maintainers to add lengthy interactive documentation that Lepiter DBs enable.

One shouldn't need to add such Lepiter DBs to the central package registry to view in list of databases in Lepiter tool. Additionally, this view will get cluttered if many packages start including Lepiter docs. Think these databases should be surfaced similar to how a class has a Comments view. This should be able to support more than one DB in a repo. I understand that loading a DB can take resources so these should be lazy loaded, only when visiting that view and clicking on the folder the Lepiter DB belongs to. Once one clicks on that a Page view is loaded on the Table of Contents if one exists or some other page/view if one is not available.

Additional notes from original Discord thread here

seandenigris commented 2 years ago

I created a tool that grabs all the baselines loaded in the image and collects any Lepiter DBs from their local git repos. It may be useful for inspiration. On the right side, the button would be labeled "Load DB", but in this case all available are loaded already.

Screen Shot 2022-07-07 at 6 56 10 AM