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

Migrate docs from docsify to docusaurus #468

Open
davidmigloz opened this issue Jun 21, 2024 · 14 comments
Open

Migrate docs from docsify to docusaurus #468

davidmigloz opened this issue Jun 21, 2024 · 14 comments
Assignees
Labels
t:documentation Improvements or additions to documentation

Comments

@davidmigloz
Copy link
Owner

davidmigloz commented Jun 21, 2024

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

@davidmigloz davidmigloz converted this from a draft issue Jun 21, 2024
@davidmigloz davidmigloz added the t:documentation Improvements or additions to documentation label Jun 21, 2024
@bettdouglas
Copy link
Contributor

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

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

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

davidmigloz commented Jun 21, 2024

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

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

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

Perfect 👌.

@davidmigloz
Copy link
Owner Author

Hey @bettdouglas!

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

@bettdouglas
Copy link
Contributor

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

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

@Nana-Kwame-bot
Copy link
Contributor

What happened to this? The docs_v2 are live right? Any reason why we aren't using that?

@davidmigloz
Copy link
Owner Author

Hey @Nana-Kwame-bot ,

The base for the new docs is there, we have docsaurus running in https://beta.langchaindart.dev/.

Now we need to:

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

@bettdouglas do you still want to give it a try?

@bettdouglas
Copy link
Contributor

@davidmigloz please checkout PR #628
Feliz Navidad!!!
Thank you for your awesome work on langchain this year.

@davidmigloz
Copy link
Owner Author

Awesome, thanks again! I'll review it soon.
Happy holidays! 🎄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
t:documentation Improvements or additions to documentation
Projects
Status: 🏗 In Progress
Development

No branches or pull requests

3 participants