Skip to content
This repository has been archived by the owner on Oct 16, 2024. It is now read-only.

Add docs engine #28

Closed
aguschin opened this issue Jan 21, 2022 · 9 comments
Closed

Add docs engine #28

aguschin opened this issue Jan 21, 2022 · 9 comments
Labels
p1-important Active priorities to deal within next sprints type: enhancement Something is not clear, small updates, improvement suggestions

Comments

@aguschin
Copy link
Contributor

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

@yathomasi
Copy link
Contributor

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.

@julieg18 julieg18 added type: enhancement Something is not clear, small updates, improvement suggestions p1-important Active priorities to deal within next sprints labels Feb 17, 2022
@aguschin
Copy link
Contributor Author

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?
cc @mike0sv @shcheklein

@yathomasi
Copy link
Contributor

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.
It will be similar to dvc.org/doc and If you mean the syntax, it will be markdown files as in https://github.com/iterative/dvc.org/tree/master/content/docs

@rogermparent
Copy link
Contributor

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.

@mike0sv
Copy link
Contributor

mike0sv commented Apr 14, 2022

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?

@julieg18
Copy link
Contributor

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 :)

@mike0sv
Copy link
Contributor

mike0sv commented Apr 14, 2022

Ok, is there any timeline for this?

@rogermparent
Copy link
Contributor

rogermparent commented Apr 14, 2022

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.

@mike0sv mike0sv mentioned this issue Apr 14, 2022
1 task
@rogermparent
Copy link
Contributor

Closed by #45

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
p1-important Active priorities to deal within next sprints type: enhancement Something is not clear, small updates, improvement suggestions
Projects
None yet
Development

No branches or pull requests

5 participants