Giter Site home page Giter Site logo

Add docs engine about mlem.ai HOT 9 CLOSED

iterative avatar iterative commented on June 15, 2024 3
Add docs engine

from mlem.ai.

Comments (9)

yathomasi avatar yathomasi commented on June 15, 2024 4

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.

from mlem.ai.

rogermparent avatar rogermparent commented on June 15, 2024 3

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.

from mlem.ai.

aguschin avatar aguschin commented on June 15, 2024 2

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

from mlem.ai.

yathomasi avatar yathomasi commented on June 15, 2024 2

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

from mlem.ai.

mike0sv avatar mike0sv commented on June 15, 2024 2

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?

from mlem.ai.

rogermparent avatar rogermparent commented on June 15, 2024 1

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.

from mlem.ai.

julieg18 avatar julieg18 commented on June 15, 2024

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

from mlem.ai.

mike0sv avatar mike0sv commented on June 15, 2024

Ok, is there any timeline for this?

from mlem.ai.

rogermparent avatar rogermparent commented on June 15, 2024

Closed by #45

from mlem.ai.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.