From 7acd6c099276d98d7f09369fb574bdc1efec4d6c Mon Sep 17 00:00:00 2001 From: ishaan-jaff Date: Mon, 31 Jul 2023 10:37:22 -0700 Subject: [PATCH] improve docs --- docs/contributing.md | 34 ++++++++++++++++++++++++++++++++++ mkdocs.yml | 2 ++ 2 files changed, 36 insertions(+) create mode 100644 docs/contributing.md diff --git a/docs/contributing.md b/docs/contributing.md new file mode 100644 index 000000000..1c831e204 --- /dev/null +++ b/docs/contributing.md @@ -0,0 +1,34 @@ +## Contributing to Documentation +Clone litellm +``` +git clone https://github.com/BerriAI/litellm.git +``` + +### Local setup for locally running docs + +#### Installation +``` +pip install mkdocs +``` + +#### Locally Serving Docs +``` +mkdocs serve +``` +If you see `command not found: mkdocs` try running the following +``` +python3 -m mkdocs serve +``` + +This command builds your Markdown files into HTML and starts a development server to browse your documentation. Open up [http://127.0.0.1:8000/](http://127.0.0.1:8000/) in your web browser to see your documentation. You can make changes to your Markdown files and your docs will automatically rebuild. + +[Full tutorial here](https://docs.readthedocs.io/en/stable/intro/getting-started-with-mkdocs.html) + +### Making changes to Docs +- All the docs are placed under the `docs` directory +- If you are adding a new `.md` file or editing the hierarchy edit `mkdocs.yml` in the root of the project +- After testing your changes, make a change to the `main` branch of [github.com/BerriAI/litellm](https://github.com/BerriAI/litellm) + + + + diff --git a/mkdocs.yml b/mkdocs.yml index 8d92fff43..8ad425f76 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -11,5 +11,7 @@ nav: - 💡 Support: - Troubleshooting & Help: troubleshoot.md - Contact Us: contact.md + - Contributing: + - Contributing to liteLLM: contributing.md theme: readthedocs