Repository navigation
Improve API documenting #5
Description
Currently when the LM api is changed, one has to make a PR in both the LM main repo, and this repo to document the changes. Even worse, one may also need to create a PR in the example applets repo.
The whole benefit of having a mono-repo is to prevent these separate PRs, so we may want to look into merging everything together into the main repo. The examples repo could definitely be combined with the main repo (maybe just at the top level, instead of under packages).
The website shouldn't be combined in my opinion (and that would even give us trouble with the domain name). But it may be possible to move only the docs section of the site to there, and dynamically fetch this data when building the website.
More thought needs to be put into this idea however.
Activity
sancarn commentedon Jun 30, 2021
An option to consider would be repo links. Like this - i.e. the website could link directly to a folder in LaunchMenu/LaunchMenu which contains mdx files. For the website. Only problem is the testing story becomes a bit of a mess... But you can at least keep it to 1 PR at that point.
One potential concern however is that in that example above, i think that might be linking to a specific version of the repo... In which case there would at least have to be 1 PR on release to the main website, but at least that can be done by project admins instead of contributors..
TarVK commentedon Jul 1, 2021
Interesting, I didn't know about that feature. I think the same can be accomplished programmaticly during website building, but this may be easier to setup so worth considering if it works as well. In either case there are a couple of problems to consider though: