Skip to content

refactor: align with docusaurus version structure #476

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

Merged
merged 11 commits into from
Oct 22, 2024
Merged

Conversation

jakerachleff
Copy link
Contributor

@jakerachleff jakerachleff commented Oct 21, 2024

Moves our docs to meet docusaurus standards.

  • Current docs moved from versioned-docs/version-2.0 to the docs/ folder
  • Old docs go under versioned-docs/version-old

Doing this so that we can actually conform to docusaurus standards, and therefore use their instructions on how to do things (like SEO optimization for new docs vs old docs).

NOTES FOR REVIEW

I didn't make many changes here except for:

  1. moving old doc files to the version-1.0
  2. Updating our langsmith cookbooks script we use to generate cookbooks in the navbar

Copy link

vercel bot commented Oct 21, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
langsmith-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 22, 2024 0:32am

Copy link
Contributor

@efriis efriis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

assuming everything else is just file moves

Comment on lines 45 to 48
label: "stable",
banner: "none",
badge: false,
path: "old",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
label: "stable",
banner: "none",
badge: false,
path: "old",
label: "old",
banner: "unmaintained",
badge: false,
path: "old",

},
"2.0": {
"1.0": {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

might be worth renaming this "old" just to match - doesn't have to be a number string afaik

versions.json Outdated
@@ -1,3 +1,3 @@
[
"2.0"
"1.0"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if renaming to old need to update this to "old" too

Copy link
Contributor

@efriis efriis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

for posterity might be worth listing the move part in the pr description - not a huge deal if lots of moves

docs/ -> versioned-docs/old
versioned-docs/2.0 -> docs/

etc

@jakerachleff
Copy link
Contributor Author

for posterity might be worth listing the move part in the pr description - not a huge deal if lots of moves

docs/ -> versioned-docs/old versioned-docs/2.0 -> docs/

etc

updated!

@jakerachleff jakerachleff merged commit 077d0d3 into main Oct 22, 2024
6 checks passed
@jakerachleff jakerachleff deleted the 2024-10-21-seo branch October 22, 2024 00:33
dqbd pushed a commit to JakubKontra/langsmith-docs that referenced this pull request Oct 26, 2024
Moves our docs to meet docusaurus standards.

- Current docs moved from `versioned-docs/version-2.0` to the `docs/`
folder
- Old docs go under `versioned-docs/version-old`

Doing this so that we can actually conform to docusaurus standards, and
therefore use their instructions on how to do things (like SEO
optimization for new docs vs old docs).

## NOTES FOR REVIEW
I didn't make many changes here except for:
1. moving old doc files to the `version-1.0`
2. Updating our langsmith cookbooks script we use to generate cookbooks
in the navbar
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants