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

layout #2972

Merged
merged 22 commits into from
Jan 14, 2025
Merged

layout #2972

merged 22 commits into from
Jan 14, 2025

Conversation

eyurtsev
Copy link
Contributor

@eyurtsev eyurtsev commented Jan 9, 2025

Some docs layout improvements to help guide user journey.

Currently we have Home | Tutorials | How-tos | Concepts | Reference in top-level horizontal navigation bar.

Here we make these updates:

  • Top-level horizontal navigation bar is just Home | API Reference
  • Add vertical sidebar to Home with sections:
    • Introduction
    • Get started
    • Guides
    • Resources

Get Started contains quickstarts for LG and LG Platform / deployment. These are tutorials in Diataxis terms.

Guides contains index pages for how-tos, concepts, tutorials.

Advantage of this organization is that users are directed naturally down the sidebar from Intro -> Get started -> How-tos, which is roughly how we expect them to proceed.

This also makes deployment info more accessible as it is highlighted in the "Getting started" section.

Screenshot 2025-01-14 at 1 37 01 PM

@eyurtsev eyurtsev force-pushed the eugene/langgraph_nav branch from af322f1 to fba5ca7 Compare January 9, 2025 17:24
@ccurme ccurme marked this pull request as ready for review January 14, 2025 20:21
Copy link
Contributor Author

@eyurtsev eyurtsev left a comment

Choose a reason for hiding this comment

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

gogogo

@ccurme ccurme enabled auto-merge January 14, 2025 20:28
@ccurme ccurme merged commit 9b6e6d6 into main Jan 14, 2025
59 checks passed
@ccurme ccurme deleted the eugene/langgraph_nav branch January 14, 2025 20:30
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.

3 participants