langchain_dart
langchain_dart copied to clipboard
docs(docs_v2): Add docusaurus as per #468
- 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.
Also, what are your thoughts on the blogging feature? Should we keep it for announcements?
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.
Sorry for the delay! I'll book some time this week to go over it
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 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
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_v2is 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:
- Migrate all the existing docs, with the existing structure to docsaurus
- Deploy those to https://langchaindart.dev/ and decommission the old docs
- Progressively migrate to the new structure
What do you think @bettdouglas?
@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.
No worries @bettdouglas, that's perfect, thanks!