doc(docs): add main contributing page

Author: MacOS

docs/contributing/contributing.md

@@ -14,12 +14,14 @@ permalink: /contributing
 {: .warning}
 > Have you found a security issue? Then please jump to [Security Vulnerabilities](#security-vulnerabilities).
 
+On this page, we provide information ``llmware`` contributions.
+There are **two ways** on how you can contribute.
+The first is by making **code contributions**, and the second by making contributions to the **documentation**.
+Please look at our [contribution suggestions](#how-can-you-contribute) if you need inspiration, or take a look at [open issues](#open-issues).
+
 Contributions to `llmware` are welcome from everyone.
 Our goal is to make the process simple, transparent, and straightforward.
-
-On this page, we provide information for people interested in contributing to ``llmware``.
-This includes information on contribution areas and the contribution process.
-
+We are happy to receive suggestions on how the process can be improved.
 
 ## How can you contribute?
 
@@ -46,62 +48,10 @@ Here is a non exhaustive list of contributions you can make.
 11. Answer questions in our [Discord channel](https://discord.gg/MhZn5Nc39h), especially in the [technical support forum](https://discord.com/channels/1179245642770559067/1218498778915672194)
 12. Post projects in which you use ``llmware`` in our Discord forum [made with llmware](https://discord.com/channels/1179245642770559067/1218567269471486012), ideially with a link to a public GitHub repository
 
-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
-<iframe width="560" height="315" src="https://www.youtube.com/embed/2xDefZ4oBOM?si=IAHkxpQkFwnWyYTL" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
-In ``llmware``, a *library* is a collection of documents.
-A library is responsible for parsing, text chunking, and indexing.
-
-#### Embeddings
-<iframe width="560" height="315" src="https://www.youtube.com/embed/xQEk6ohvfV0?si=GAPle5gVdVPkYKWv" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
-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
-<iframe width="560" height="315" src="https://www.youtube.com/embed/swiu4oBVfbA?si=rKbgO3USADCqICqr" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
-In ``llmware``, a *prompt* is an input to model.
-
-#### Model Catalog
-In ``llmware``, a *model catalog* is a collection of models.
-
-
-## 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.
-
-## Documentation contributions
-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)
-
 ## 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.
+- Look for issues, if you are a new to the project, look for issues with the `good first issue` label.
 - 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.
@@ -117,7 +67,7 @@ Please follow the process at [Reporting a Vulnerability](https://github.com/llmw
 
 ## GitHub workflow
 
-Generally, we follow the [``fork-and-pull``](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) Git workflow.
+We follow the [``fork-and-pull``](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) Git workflow.
 
 1.  [Fork](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo) the repository on GitHub.
 2. Clone your fork to your local machine with `git clone git@github.com:<yourname>/llmware.git`.
@@ -134,5 +84,10 @@ git fetch upstream
 git checkout upstream/main -b my-topic-branch
 ```
 
-## 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)!
+## Community
+Questions and discussions are welcome in any shape or form.
+Please fell free to join our community on our discord channel, on which we are active daily.
+You are also welcome if you just want to post an idea!
+
+- [Discord Channel](https://discord.gg/MhZn5Nc39h)
+- [GitHub discussions](https://github.com/llmware-ai/llmware/discussions)