search

bentoml / bentoctl

Fast model deployment on any cloud 🚀
https://bentoml.com
Other
175 stars 30 forks source link

docs: trying out mkdocs #136

Closed jjmachan closed 2 years ago

jjmachan commented 2 years ago

Description

An experiment to see what a Mkdocs site for bentoctl might look like and decide if we would like to have something like this.

codecov[bot] commented 2 years ago

Codecov Report

Merging #136 (9661dd6) into main (2919dc5) will not change coverage. The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #136   +/-   ##
=======================================
  Coverage   72.20%   72.20%           
=======================================
  Files          18       18           
  Lines         957      957           
=======================================
  Hits          691      691           
  Misses        266      266
Flag Coverage Δ
unit-tests 72.20% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

:mega: Codecov can now indicate which changes are the most critical in Pull Requests. Learn more

jjmachan commented 2 years ago

@yubozhao I tried creating a quick mkdocs site to deploy the docs we have, just as an experiment. You can see the example site here https://jjmachan.github.io/bentoctl/

One really neat feature is that we get the CLI References autogenerated which could be really helpful for the users https://jjmachan.github.io/bentoctl/cli-reference/

jjmachan commented 2 years ago

closing this for now since we have better ideas for a more unified doc. For now all the docs are in /docs folder