From c642e2191811e915c84d06952380feaa915667c7 Mon Sep 17 00:00:00 2001 From: Stefan Bachhofner Date: Sat, 6 Apr 2024 20:52:14 +0200 Subject: [PATCH] doc(docs): re-organise contributing such that code and documentation contributions have their own sites --- docs/contributing/code.md | 68 +++++++++++++++++++++++++ docs/{ => contributing}/contributing.md | 0 docs/contributing/documentation.md | 31 +++++++++++ 3 files changed, 99 insertions(+) create mode 100644 docs/contributing/code.md rename docs/{ => contributing}/contributing.md (100%) create mode 100644 docs/contributing/documentation.md diff --git a/docs/contributing/code.md b/docs/contributing/code.md new file mode 100644 index 00000000..321f3804 --- /dev/null +++ b/docs/contributing/code.md @@ -0,0 +1,68 @@ +--- +layout: default +title: Code contributions +parent: Contributing +nav_order: 1 +permalink: /contributing/code +--- +# Contiributing code +One way to contribute to ``llmware`` is by contributing to the code base. + +We briefly describe some of the important modules of ``llmware`` next, so you can more easily navigate the code base. +For newcomers, we embed links to our [fast start series from YouTube](https://www.youtube.com/playlist?list=PL1-dn33KwsmD7SB9iSO6vx4ZLRAWea1DB). + +# Core modules + +## Library + +In ``llmware``, a *library* is a collection of documents. +A library is responsible for parsing, text chunking, and indexing. + +## Embeddings + +In ``llmware``, an *embedding* is a vector store and an embedding model. +An embedding is responsible for applying an embedding model to a library, storing the embeddings in a vector store, and providing access to the embeddings with natural language queries. + +## Prompts + +In ``llmware``, a *prompt* is an input to model. + +## Model Catalog +In ``llmware``, a *model catalog* is a collection of models. + + +## Categories of code contributions + +### New or Enhancement to existing Features +You want to submit a code contribution that adds a new feature or enhances an existing one? +Then the best way to start is by opening a discussion in our [GitHub discussions](https://github.com/llmware-ai/llmware/discussions). +Please do this before you work on it, so you do not put effort into it just to realise after submission that +it will not be merged. + +### Bugs +If you encounter a bug, you can + +- File an issue about the bug. +- Provide a self-contained minimal example that reproduces the bug, which is extremely important. +- Provide possible solutions for the bug. +- Submit a pull a request to fix the bug. + +We encourage you to read [How to create a Minimal, Reproducible Example](https://stackoverflow.com/help/minimal-reproducible-example) from the Stackoverflow helpcenter, and the tag description of [self-container](https://stackoverflow.com/tags/self-contained/info), also from Stackoverflow. + +## Open Issues +If you're interested in existing issues, you can + +- Look for issues with the `good first issue` label as a good place to get started. +- Provide answers for questions in our [GitHub discussions](https://github.com/llmware-ai/llmware/discussions) +- Provide help for bug or enhancement issues. + - Ask questions, reproduce the issues, or provide solutions. + - Pull a request to fix the issue. + + + +## Security Vulnerabilities +**If you believe you've found a security vulnerability, then please _do not_ submit an issue ticket or pull request or otherwise publicly disclose the issue.** +Please follow the process at [Reporting a Vulnerability](https://github.com/llmware-ai/llmware/blob/main/Security.md) + +# Do you have questions or just want to bounce around an idea? +Questions and discussions are welcome in our [GitHub discussions](https://github.com/llmware-ai/llmware/discussions)! diff --git a/docs/contributing.md b/docs/contributing/contributing.md similarity index 100% rename from docs/contributing.md rename to docs/contributing/contributing.md diff --git a/docs/contributing/documentation.md b/docs/contributing/documentation.md new file mode 100644 index 00000000..2e09df11 --- /dev/null +++ b/docs/contributing/documentation.md @@ -0,0 +1,31 @@ +--- +layout: default +title: Documentation contributions +parent: Contributing +nav_order: 2 +--- +# Contributing documentation +One way to contribute to ``llmware`` is by contributing documentation. + +There are two ways to contribute to the ``llmware`` documentation. +The first is via docstrings in the code, and the second is what you are currently reading. +In both areas, you can contribute in a lot of ways. +Here is a non exhaustive list of these ways. + +1. Add documentation (e.g., adding a docstring to a function) +2. Update documentation (e.g., update a docstring that is not in sync with the code) +3. Simplify documentation (e.g., formulate a docstring more clearly) +4. Enhance documentation (e.g., add more examples to a docstring or fix typos) + +## Code + +## Docs + +## Open Issues +If you're interested in existing issues, you can + +- Look for issues with the `good first issue` and `documentation` label as a good place to get started. +- Provide answers for questions in our [GitHub discussions](https://github.com/llmware-ai/llmware/discussions) +- Provide help for bug or enhancement issues. + - Ask questions, reproduce the issues, or provide solutions. + - Pull a request to fix the issue.