langchain_dart icon indicating copy to clipboard operation
langchain_dart copied to clipboard

docs(docs_v2): Add docusaurus as per #468

Open bettdouglas opened this issue 1 year ago • 2 comments
trafficstars

  • Description: This adds docusaurus to the site.
  • Issue: #468
  • Dependencies: docusaurus
  • Tag maintainer: @davidmigloz

Right now, there are a couple of broken links that ought to link to the various guides, tutorials and various how-tos that we could implement that are in the Python documentation. I've configured docusaurus to warn instead of throw when building the website.

bettdouglas avatar Aug 09 '24 09:08 bettdouglas

Also, what are your thoughts on the blogging feature? Should we keep it for announcements?

bettdouglas avatar Aug 09 '24 09:08 bettdouglas

Awesome! Thank you for your work. I'll check it out this weekend. I need to familiarise myself a bit with docusaurus. I'll set up a deployment workflow to a temporary subdomain so we can see the deployed version.

davidmigloz avatar Aug 09 '24 09:08 davidmigloz

Sorry for the delay! I'll book some time this week to go over it

davidmigloz avatar Aug 26 '24 10:08 davidmigloz

Hey @bettdouglas,

Sorry again for the extra delay, I feel bad for breaking my promise. I've been quite busy the last few weeks and didn't have much time to dedicate to the project. Reviewing the PR is still on the top of my list 🙏

davidmigloz avatar Sep 16 '24 12:09 davidmigloz

@davidmigloz Thanks for all the work you do on langchain.dart. I've also not been at my best in migrating the documentation.

Good thing is I've migrated the integrations and I'm finalizing on the conceptual guide. The next steps will now be focused on implementing the How-to guides and Tutorials since those are quite wide but focused topics which can be done progressively

bettdouglas avatar Sep 18 '24 05:09 bettdouglas

I finally got some time to review it, thanks for your work again it's looking great!

I wanted to push a couple of updates to this PR, but I merged it by mistake. So I added them here https://github.com/davidmigloz/langchain_dart/pull/548

I have set up the deployment workflows:

  • Whenever a PR with changes in docs_v2 is created, a preview will be deployed to a temporal URL (see here)
  • When the PR is merged to main, it will be deployed in https://beta.langchaindart.dev/

I was thinking that it'd great to:

  1. Migrate all the existing docs, with the existing structure to docsaurus
  2. Deploy those to https://langchaindart.dev/ and decommission the old docs
  3. Progressively migrate to the new structure

What do you think @bettdouglas?

davidmigloz avatar Sep 20 '24 22:09 davidmigloz

@davidmigloz I think that's a good idea. Sorry I missed this notification. I'll set up some time today to migrate the docs as they are then make a PR once done. I aim to have this by the weekend. Hope that's okay.

bettdouglas avatar Oct 02 '24 11:10 bettdouglas

No worries @bettdouglas, that's perfect, thanks!

davidmigloz avatar Oct 02 '24 11:10 davidmigloz