-
Notifications
You must be signed in to change notification settings - Fork 12
Add docs engine #28
Comments
We are creating reusable components for documentation. @rogermparent has already made great progress over it. I think we now need a final review and final changes. |
Hi folks! Just letting you know that we're getting closer to MLEM release and will be putting together docs for it in upcoming weeks. Could you suggest us where to look to understand what's required for us to start adding docs to the website? |
With current work by Roger on the reusable package for documentation over multiple websites. |
Anything that works in the dvc.org docs engine will work in the mlem.ai one as they'll be the exact same engine, so if you want to get a headstart on writing docs before any mlem.ai implementation is made, you can write them in dvc.org to see a rendered preview and we can copy the markdown files in once mlem.ai has its own docs. |
Hey folks! I'm going to start working on documentation now. I am planning to create a PR with /content/docs directory with files similar to dvc.org repo and you can add docs engine to the same PR. Is this ok? |
Sounds good! Though we will probably want to add the docs engine in a separate PR as it will be a large PR that will require lots of reviews :) |
Ok, is there any timeline for this? |
Not officially, but we're planning on it being assigned to me as either the next issue I start on. The shared docs engine package just become (mostly) finalized so it's just a matter of integrating that into mlem.ai. If nothing goes wrong we could have a rough docs setup on mlem.ai by the end of the week, otherwise it'll take one or two more. |
Closed by #45 |
MLEM release is planned for the end of Q1. We'll need the docs engine running on the website, and I assume the very first parts of documentation will be ready in the 2nd half of February.
CC @rogermparent @julieg18 @yathomasi
The text was updated successfully, but these errors were encountered: