diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 210f232b170..5aff846511c 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -43,11 +43,13 @@ If you're seeing a delay in your PR being merged, ping the LiteLLM Team on [Slac + + ๐Ÿ†• New Feature ๐Ÿ› Bug Fix ๐Ÿงน Refactoring -๐Ÿ“– Documentation +๐Ÿ“– Documentation (submit doc PRs to [litellm-docs](https://github.com/BerriAI/litellm-docs)) ๐Ÿš„ Infrastructure โœ… Test diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8ac83341f64..53ca0922f52 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -242,7 +242,7 @@ If `make test-unit` fails: - **Write descriptive commit messages**: Help reviewers understand your changes - **Keep PRs focused**: One feature/fix per PR - **Test edge cases**: Don't just test the happy path -- **Update documentation**: If you change APIs, update docs +- **Update documentation**: If you change APIs, update docs in the [litellm-docs](https://github.com/BerriAI/litellm-docs) repo (see [Documentation](#documentation) below) ## Building and Running Locally @@ -312,6 +312,12 @@ Ensure the UI builds successfully before submitting your PR: npm run build ``` +## Documentation + +LiteLLM documentation lives in a **separate repository**: [BerriAI/litellm-docs](https://github.com/BerriAI/litellm-docs), served at [docs.litellm.ai](https://docs.litellm.ai). + +**Do not create or edit documentation files in this repository.** If your changes require documentation updates, please open a separate PR against the [litellm-docs](https://github.com/BerriAI/litellm-docs) repo. + ## Submitting Your PR 1. **Push your branch**: `git push origin your-feature-branch` @@ -336,7 +342,7 @@ Looking for ideas? Check out: - ๐Ÿ› [Good first issues](https://github.com/BerriAI/litellm/labels/good%20first%20issue) - ๐Ÿš€ [Feature requests](https://github.com/BerriAI/litellm/labels/enhancement) -- ๐Ÿ“š Documentation improvements +- ๐Ÿ“š Documentation improvements (in the [litellm-docs](https://github.com/BerriAI/litellm-docs) repo) - ๐Ÿงช Test coverage improvements - ๐Ÿ”Œ New LLM provider integrations