Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(docs_v2): Add docusaurus as per #468 #517

Merged
merged 3 commits into from
Sep 20, 2024

Conversation

bettdouglas
Copy link
Contributor

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
Copy link
Contributor Author

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

@davidmigloz
Copy link
Owner

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
Copy link
Owner

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

@davidmigloz
Copy link
Owner

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 🙏

Squashed commit of the following:

commit cd04736756d9ec9f4b9533c85007d474db8ba558
Author: Douglas Bett <bettdalpha@gmail.com>
Date:   Wed Sep 18 08:53:39 2024 +0300

    update sidebars.js

commit d3fed3c17185fc29f1a4d7221f6be86265d60cf3
Author: Douglas Bett <bettdalpha@gmail.com>
Date:   Wed Sep 18 08:53:20 2024 +0300

    Add installation docs

commit 36fd583db116c69be132edaa5a4ec092bbbfbd92
Author: Douglas Bett <bettdalpha@gmail.com>
Date:   Wed Sep 18 08:52:09 2024 +0300

    Add concepts documentation

commit 48317baef7119d8dd0d1b5892d21a87ec69818c8
Author: Douglas Bett <bettdalpha@gmail.com>
Date:   Wed Sep 18 07:43:23 2024 +0300

    Add integrations

commit bedfcda18e10af33cf64a95ccf9925226233e098
Author: Douglas Bett <bettdalpha@gmail.com>
Date:   Wed Sep 18 07:42:57 2024 +0300

    switch to autogenerated sidebar
@bettdouglas
Copy link
Contributor Author

bettdouglas commented Sep 18, 2024

@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

docs_v2/docusaurus.config.js Show resolved Hide resolved
@davidmigloz davidmigloz merged commit 65bcef8 into davidmigloz:main Sep 20, 2024
1 check passed
@davidmigloz
Copy link
Owner

davidmigloz commented Sep 20, 2024

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 #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?

@bettdouglas
Copy link
Contributor Author

bettdouglas commented Oct 2, 2024

@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.

@davidmigloz
Copy link
Owner

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants