search

davidmigloz / langchain_dart

Build LLM-powered Dart/Flutter applications.
https://langchaindart.dev
MIT License
426 stars 75 forks source link

Migrate docs from docsify to docusaurus #468

Open davidmigloz opened 5 months ago

davidmigloz commented 5 months ago

In an effort to improve our docs, we would like to align them with the official LangChain doc structure (which has recently been completely rembumped using the diátaxis methodology).

As part of this, we need to migrate the static site generator from docsify to docusaurus.io, the one used by the official docs (and more feature-rich and better maintained than docsify).

bettdouglas commented 4 months ago

Hey @davidmigloz I can help with kickstarting this.

I'll try setting docusaurus.io in a different branch and deploy to Cloudflare Pages for a start as we try following the diátaxis methodology. What do you think?

davidmigloz commented 4 months ago

@bettdouglas awesome!

I think for hosting them we can still use GitHub pages as we currently do, so that we keep everything in one place.

I can set up a temporal subdomain for deploying your working branch until we are ready to replace the old documentation. What do you think?

bettdouglas commented 4 months ago

Completely agree @davidmigloz.

Let me check how to deploy Docusaurus to GitHub Pages. I'll be back once I've found a working solution.

davidmigloz commented 4 months ago

Perfect. I guess it's just running npm run build and deploy whatever is in the generated /build folder.

Maybe you can create a basic site using docsaurus in your branch, and then I'll add the CICD workflow. And from there you can continue implementing the rest.

bettdouglas commented 4 months ago

That'll be perfect. Then in terms of the folder structure, can I rename the docs folder name to something like docsify_docs or replace the contents of the docs with the new docusaurus contents?

davidmigloz commented 4 months ago

Maybe you can create a folder docs_v2 and setup the new site there for now, and once your branch is ready to be merged, we delete the previous docs folder and rename docs_v2 to docs.

bettdouglas commented 4 months ago

Perfect 👌.

davidmigloz commented 4 months ago

Hey @bettdouglas!

Have you had a chance to make any progress on this?

bettdouglas commented 4 months ago

Hey @davidmigloz sorry I've been a bit busy this week & late last week. Give me some time to finish up some tiny things this weekend then let you know.

davidmigloz commented 4 months ago

Sure, no rust at all. I was just curious if I could help. Thanks!