GithubHelp home page GithubHelp logo

Comments (8)

mfreeman451 avatar mfreeman451 commented on August 26, 2024 1

Going to set this up on something locally and get familiar https://gohugo.io/hosting-and-deployment/hosting-on-github/

from langchaingo.

tmc avatar tmc commented on August 26, 2024 1

We should use the best tool that gets us an experience like the other sites. I prefer a go based tool for sure but am not going to be dogmatic about it.

edit: Updated issue indicating the technologies the python and ts implementations use. I'd love to use hugo but someone needs to demonstrate that it's going to work well.

from langchaingo.

nguyenvanduocit avatar nguyenvanduocit commented on August 26, 2024

Another tools is Vitepress, it's a is battery-included site generator for technical docs. take a look at : https://vitepress.dev/

from langchaingo.

ChristianSch avatar ChristianSch commented on August 26, 2024

I think a go project lends itself for documentation in go without introducing another toolchain

from langchaingo.

ChristianSch avatar ChristianSch commented on August 26, 2024

Maybe we could clarify the needs beforehand. There are two different documentation areas I guess: the package API (godoc) and the "user guide".

Additionally, something like this might be useful:

What I missed with hugo was a good documentation template but I just found this one: https://themes.gohugo.io/themes/doks/

from langchaingo.

tmc avatar tmc commented on August 26, 2024

I like https://themes.gohugo.io/themes/docsy/ but we'd need some theming to match the existing docs sites (https://python.langchain.com/en/latest/, https://js.langchain.com/docs/).

I think we should go Hugo+Docsy+(custom theming) or Docusarus.

from langchaingo.

deshetti avatar deshetti commented on August 26, 2024

@tmc My 2 cents.

Docusaurus is pretty straight forward and will match the docs site like here: https://js.langchain.com/docs/ as it seems like pretty much OOB theme.

The time would be well worth spending on implementing core features than having a customized theme IMO.

from langchaingo.

tmc avatar tmc commented on August 26, 2024

@tmc My 2 cents.

Docusaurus is pretty straight forward and will match the docs site like here: https://js.langchain.com/docs/ as it seems like pretty much OOB theme.

The time would be well worth spending on implementing core features than having a customized theme IMO.
Yeah I've come to agree. Docusaurus it is!

from langchaingo.

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.