Skip to content

chore: trim README for clarity and structure#5258

Merged
leseb merged 4 commits intollamastack:mainfrom
EleanorWho:ehu/readme-trim
Mar 25, 2026
Merged

chore: trim README for clarity and structure#5258
leseb merged 4 commits intollamastack:mainfrom
EleanorWho:ehu/readme-trim

Conversation

@EleanorWho
Copy link
Contributor

@EleanorWho EleanorWho commented Mar 24, 2026

What does this PR do?

Trim README for clarity and structure

  • Add table of contents
  • Fix heading hierarchy (H3 → H2 throughout)
  • Merge related sections (Documentation + Client SDKs → Resources; Community + Star History + Contributors)
  • Fold one-line installer into Overview, remove redundant Benefits sub-section
  • Tighten prose throughout

Improves AgentReady Concise Documentation score from 69 to 85/100 (Threshold: ≥75)

@meta-cla meta-cla bot added the CLA Signed This label is managed by the Meta Open Source bot. label Mar 24, 2026
Copy link
Collaborator

@leseb leseb left a comment

Choose a reason for hiding this comment

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

Thanks! While we are it, can you:

  • remove the Post Training column from the API / Providers table?
  • remove the Builtin distribution
  • Remove the diagram since it's not representing the state of the stack today

If others agree, i'd even remove the API Providers & Distributions since the doc has an equivalent, (i think/hope).

Thanks!

Signed-off-by: Eleanor Hu <ehu@redhat.com>
@EleanorWho
Copy link
Contributor Author

@leseb Done with the first 3 suggestions. And I agree with the tables of Distributions because the doc contains more detailed information. But I'm not sure about the API Providers table since it's more intuitive to scan for information. However, I also think this table is too large to read.

What about regroup it into something like:

  ┌───────────┬───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
  │    API    │                                                       Providers                                                       │
  ├───────────┼───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤
  │ Inference │ OpenAI, Anthropic, Gemini, Ollama, vLLM, Fireworks, Together, Groq, AWS Bedrock, SambaNova, Cerebras, WatsonX, TGI,   │
  │           │ NVIDIA NIM/NEMO                                                                                                       │
  ├───────────┼───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤
  │  Agents   │ Fireworks, Together, PyTorch ExecuTorch                                                                               │
  ├───────────┼───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤
  │ VectorIO  │ ChromaDB, Milvus, Qdrant, Weaviate, SQLite-vec, PG Vector, Infinispan, NVIDIA NEMO                                    │
  ├───────────┼───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤
  │  Safety   │ SambaNova, AWS Bedrock, Together, NVIDIA NIM                                                                          │
  ├───────────┼───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤
  │   Eval    │ NVIDIA NEMO, NVIDIA                                                                                                   │
  ├───────────┼───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤
  │ DatasetIO │ HuggingFace, NVIDIA NEMO, NVIDIA                                                                                      │
  └───────────┴───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘

Copy link
Collaborator

@leseb leseb left a comment

Choose a reason for hiding this comment

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

@franciscojavierarceo @mattf @cdoern how do you feel about removing API Providers & Distributions section since it's not well maintained and our doc has all of it covered (and it's auto-generated)?

@leseb leseb merged commit ecded04 into llamastack:main Mar 25, 2026
14 checks passed
@leseb
Copy link
Collaborator

leseb commented Mar 25, 2026

@franciscojavierarceo @mattf @cdoern how do you feel about removing API Providers & Distributions section since it's not well maintained and our doc has all of it covered (and it's auto-generated)?

let's revisit later, not urgent.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA Signed This label is managed by the Meta Open Source bot.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants