cog icon indicating copy to clipboard operation
cog copied to clipboard

Cog docs

Open DeNeutoy opened this issue 3 years ago • 2 comments

Some web docs for Cog using Mkdocs Material. Currently the docs are kinda hard to discover, but this should help with that whilst allowing the docs to be:

  1. kept in markdown files on github
  2. kept up to date with the package (if you choose to use the github action, which deploys the github pages page on pushes to main)

You can see the deployed docs here.

I can remove the image if you lmk paths to assets you have, as they can be urls too!

DeNeutoy avatar Feb 15 '22 01:02 DeNeutoy

Hey @DeNeutoy, thanks for the contribution! This is pretty neat. I especially like the TOC, which makes is much easier to navigate through all the docs.

I will bring this to the team and see if this is something we want to ship. Stay tuned.

zeke avatar Feb 15 '22 16:02 zeke

Hey @DeNeutoy sorry for the long silence here. We haven't forgotten about your contribution!

Our focus for the last month+ has been on shipping a new version of Cog, but I intend to get back to this soon.

zeke avatar Mar 23 '22 21:03 zeke

A derivative version of this landed in https://github.com/replicate/cog/pull/1435 and https://cog.run is now live!

Thanks @DeNeutoy for the inspiration and sorry it took ... (checks watch) ... 22 months to get to it. 🙈

zeke avatar Dec 14 '23 22:12 zeke