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

[feat: organize docs by feature area] #479

Closed
wants to merge 17 commits into from
Closed

Conversation

jakerachleff
Copy link
Contributor

@jakerachleff jakerachleff commented Oct 23, 2024

Main Change

This PR changes our top level doc categories to match our new homepage design. Instead of:

how_to_guides:
-> ...
concepts:
-> ...

We instead have our docs in terms of product categories:

observability
-> concepts
-> how to guides
evaluation
-> concepts
-> how to guides
prompt engineering
-> concepts
-> how to guides
deployment
-> concepts
-> how to guides
administration
-> concepts
-> how to guides
-> pricing

Decisions Made

  1. Keep tutorials top level
  2. Keep self hosting top level
  3. Put pricing under administration
  4. Combine all conceptual docs under admin (resource hierarchy + usage + billing) into one page for simplicity
  5. Clicking on a product area defaults you into the conceptual docs
  6. Got rid of the doc card view such that the only place to see all how to guides laid out is by clicking "how to guides"

Still TODO

  • Put in all proper vercel.json redirects so this doesn't fuck over our docs links in langsmith

Thoughts for reviewers

I don't think this is the complete change. For example:

  1. I'd like to split eval how to guides further into (Experiment UI, Run Evaluations in Code (sections for SDK / REST API / etc)
  2. I'd like to move online eval into evaluation from monitoring

Not sure if people prefer incremental changes or big ones here.. I see arguments for both

Copy link

vercel bot commented Oct 23, 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 💬 1 unresolved Oct 23, 2024 6:29pm

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.

1 participant