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

docs: move sections from README to docs #1143

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

leseb
Copy link
Contributor

@leseb leseb commented Feb 18, 2025

What does this PR do?

To maintain a clean and uncluttered README for the project’s landing page, the API providers and distributions are now included in the documentation. Relevant sections have been updated as needed.

Signed-off-by: Sébastien Han [email protected]

@facebook-github-bot facebook-github-bot added the CLA Signed This label is managed by the Meta Open Source bot. label Feb 18, 2025
@ashwinb
Copy link
Contributor

ashwinb commented Feb 20, 2025

Hmm. @raghotham are you OK with this change?

@@ -47,37 +47,30 @@ We have a number of client-side SDKs available for different languages.

A number of "adapters" are available for some popular Inference and Vector Store providers. For other APIs (particularly Safety and Agents), we provide *reference implementations* you can use to get started. We expect this list to grow over time. We are slowly onboarding more providers to the ecosystem as we get more confidence in the APIs.

**Inference API**
Copy link
Contributor

Choose a reason for hiding this comment

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

I think this replacement isn't quite accurate because the former table lists individual API providers, while the replacement is a table of "distributions" (namely bundles of providers)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ah right, so should this table move to docs/source/distributions/selection.md instead? Thanks!

@leseb leseb requested a review from ashwinb February 24, 2025 10:48
To maintain a clean and uncluttered README for the project’s landing page, the
API providers and distributions are now included in the documentation. Relevant
sections have been updated as needed.

Signed-off-by: Sébastien Han <[email protected]>
@leseb leseb force-pushed the rm-distributions-readme branch from c9d0f00 to 0942329 Compare February 25, 2025 16:33
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.

3 participants