Llm 85/add readme

.github/workflows/wf_publish-docs.yml

@@ -0,0 +1,43 @@
+name: Publish documentation
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'website/**'
+
+jobs:
+  deploy-docs:
+    name: Publish documentation
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: website
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18
+          cache: npm
+          cache-dependency-path: website/package-lock.json
+
+      - name: Download CONTRIBUTING.md
+        run: |
+          curl -o CONTRIBUTING.md https://raw.githubusercontent.com/theam/eLLMental/main/CONTRIBUTING.md
+
+      - name: Install dependencies
+        run: npm ci
+      - name: Build website
+        run: npm run build
+
+      # Popular action to deploy to GitHub Pages:
+      # Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          # Build output to publish to the `gh-pages` branch:
+          publish_dir: ./website/build
+          user_name: github-actions[bot]
+          user_email: 41898282+github-actions[bot]@users.noreply.github.com

.gitignore

@@ -9,6 +9,10 @@ sarif/
 .idea/modules.xml
 .idea/jarRepositories.xml
 .idea/compiler.xml
+.idea/gradle.xml
+.idea/kotlinc.xml
+.idea/misc.xml
+.idea/saveactions_settings.xml
 .idea/libraries/
 *.iws
 *.iml

CONTRIBUTING.md

@@ -0,0 +1,145 @@
+
+We're happy to see that you're interested in contributing, that's great! In the sections below, you can see how to report
+bugs or suggest enhancements.
+
+
+## :bug: Reporting bugs
+
+Before creating a bug report, please search for similar issues to make sure that they're not already reported. If you
+don't find any, go ahead and create an issue including as many details as possible.
+
+> If you find a Closed issue that seems related to the issues that you're experiencing, make sure to reference it in the
+> body of your new one by writing its number like this => #42 (Github will auto-link it for you).
+
+Bugs are tracked as GitHub issues. Explain the problem and include additional details to help maintainers reproduce the
+problem:
+
+- Use a clear and descriptive title for the issue to identify the problem.
+- Describe the exact steps which reproduce the problem in as many details as possible.
+- Provide specific examples to demonstrate the steps. Include links to files or GitHub projects, or copy/pasteable
+  snippets, which you use in those examples. If you're providing snippets in the issue, use Markdown code blocks.
+- Describe the behavior you observed after following the steps and point out what exactly is the problem with that
+  behavior.
+- Explain which behavior you expected to see instead and why.
+- If the problem is related to performance or memory, include a CPU profile capture with your report.
+
+> Remember to label the issue with a "bug" tag
+
+## :bulb: Suggesting Enhancements
+
+Enhancement suggestions are tracked as GitHub issues. Make sure you provide the following information:
+
+- Use a clear and descriptive title for the issue to identify the suggestion.
+- Provide a step-by-step description of the suggested enhancement in as many details as possible.
+- Provide specific examples to demonstrate the steps. Include copy/pasteable snippets which you use in those examples,
+  as Markdown code blocks.
+- Describe the current behavior and explain which behavior you expected to see instead and why.
+- Explain why this enhancement would be useful to most eLLMental users and isn't something that can or should be
+  implemented as a community package.
+- List some other libraries or frameworks where this enhancement exists.
+
+> Remember to label the issue with an "enhancement" tag
+
+## :book: Improving documentation
+
+[eLLMental documentation](https://docs.ellmental.com) is treated as a live document that continues improving on a daily basis. If you find something that is missing or can be improved, please contribute, it will be of great help for other developers.
+To contribute you can use the button "Edit on github" at the top of each chapter.
+
+### Documentation principles and practices
+
+The ultimate goal of a technical document is to translate the knowledge from the technology creators into the reader's mind so that they learn. The challenging
+part here is the one in which they learn. It is challenging because, under the same amount of information, a person can suffer an information overload because
+we (humans) don't have the same information-processing capacity. That idea is going to work as our compass, it should drive our efforts so people with less
+capacity is still able to follow and understand our documentation.
+
+To achieve our goal we propose writing documentation following these principles:
+
+1. Clean and Clear
+2. Simple
+3. Coherent
+4. Explicit
+5. Attractive
+6. Inclusive
+7. Cohesive
+
+#### Principles
+
+**1. Clean and Clear**
+
+Less is more. Apple is, among many others, a good example of creating clean and clear content, where visual elements are carefully chosen to look beautiful
+(e.g. [Apple's swift UI](https://developer.apple.com/tutorials/swiftui)) and making the reader getting the point as soon as possible.
+
+The intention of every section, paragraph, and sentence must be clear, we should avoid writing details of two different things even when they are related.
+It is better to link pages and keep the focus and the intention clear, Wikipedia is the best example on this.
+
+**2. Simple**
+
+Technical writings deal with different backgrounds and expertise from the readers. We should not assume the reader knows everything we are talking about
+but we should not explain everything in the same paragraph or section. Every section has a goal to stick to the goal and link to internal or external resources
+to go deeper.
+
+Diagrams are great tools, you know a picture is worth more than a thousand words unless that picture contains too much information.
+Keep it simple intentionally omitting details.
+
+**3. Coherent**
+
+The documentation tells a story. Every section should integrate naturally without making the reader switch between different contexts. Text, diagrams,
+and code examples should support each other without introducing abrupt changes breaking the reader’s flow. Also, the font, colors, diagrams, code samples,
+animations, and all the visual elements we include, should support the story we are telling.
+
+**4. Explicit**
+
+Go straight to the point without assuming the readers should know about something. Again, link internal or external resources to clarify.
+
+The index of the whole content must be visible all the time so the reader knows exactly where they are and what is left.
+
+**5. Attractive**
+
+Our text must be nice to read, our diagrams delectable to see, and our site… a feast for the eyes!!
+
+**6. Inclusive**
+
+Everybody should understand our writings, especially the topics at the top. We have arranged the documentation structure in a way that anybody can dig
+deeper by just going down so, sections 1 to 4 must be suitable for all ages.
+
+Use gender-neutral language to avoid the use of he, him, his to refer to undetermined gender. It is better to use their or they as a gender-neutral
+approach than s/he or similars.
+
+**7. Cohesive**
+
+Writing short and concise sentences is good, but remember to use proper connectors (“Therefore”, “Besides”, “However”, “thus”, etc) that provide a
+sense of continuation to the whole paragraph. If not, when people read the paragraphs, their internal voice sounds like a robot with unnatural stops.
+
+#### Practices
+
+There are many writing styles depending on the type of document. It is common within technical and scientific writing to use Inductive and/or Deductive styles
+for paragraphs. They have different outcomes and one style may suit better in one case or another, that is why it is important to know them, and decide which
+one to use in every moment. Let’s see the difference with 2 recursive examples.
+
+**Deductive paragraphs ease the reading for advanced users but still allows you to elaborate on ideas and concepts for newcomers**. In deductive paragraphs,
+the conclusions or definitions appear at the beginning, and then, details, facts, or supporting phrases complete the paragraph’s idea. By placing the
+conclusion in the first sentence, the reader immediately identifies the main point so they can decide to skip the whole paragraph or keep reading.
+If you take a look at the structure of this paragraph, it is deductive.
+
+On the other hand, if you want to drive the readers' attention and play with it as if they were in a roller coaster, you can do so by using a different approach.
+In that approach, you first introduce the facts and ideas and then you wrap them with a conclusion. This style is more narrative and forces the reader to
+continue because the main idea is diluted in the whole paragraph. Once all the ideas are placed together, you can finally conclude the paragraph. **This style is
+called Inductive.**
+
+The first paragraph is deductive and the last one is inductive. In general, it is better to use the deductive style, but if we stick to one, our writing will start looking weird and maybe boring.
+So decide one or another being conscious about your intention.
+
+## Create your very first GitHub issue
+
+[Click here](https://github.com/theam/eLLMental/issues/new) to start making contributions to eLLMental.
+
+## Your First Code Contribution
+
+Unsure where to begin contributing to eLLMental? You can start by looking through issued tagged as `good-first-issue` and `help-wanted`:
+
+- Beginner issues - issues which should only require a few lines of code, and a test or two.
+- Help wanted issues - issues which should be a bit more involved than beginner issues.
+
+Both issue lists are sorted by the total number of comments. While not perfect, number of comments is a reasonable proxy for impact a given change will have.
+
+Make sure that you assign the chosen issue to yourself to communicate your intention to work on it and reduce the possibilities of other people taking the same assignment.

README.md

@@ -1,21 +1,34 @@
-# Ellmental(2)
+# ![eLLMental](website/static/img/logoellmental.png)
 
-![haha LLM go brrrrr](https://explosion.ai/static/1863c4dfa57ad28dbbd68e432bde34e9/66a58/llm-maximalism_meme.jpg)
+---
 
-## Contributing
+# Introduction
 
-We use IntelliJ IDEA for development. You can import the project as a Gradle project.
+The eLLMental project was born out of the necessity for developers to have a single toolset that combines flexibility,
+efficiency, and productivity while building AI-driven applications. As a team specializing in AI product development,
+we've started to find recurrent challenges that motivated us to start building this project:
 
-Install the `Save Actions Tool` plugin by `Alexandre DuBreuil` to automatically format the code on save.
+1. **Lack of Robust Tools and Libraries:** As the field is relatively new, there's a shortage of high-quality production-ready 
+tools that help developers to iterate quickly at a certain scale.
+2. **MLOps management:** There's no "single click" MLOps solutions that let developers start working on their applications 
+in a short period of time without investing a significant amount of time.
+3. **Security**: Ensuring minimal security standards of the underlying infrastructure, including network security, 
+firewall configurations, and container security, is a major challenge.
+4. **Privacy:** Sometimes it's unclear how privacy is handled when using models that are behind an API provided by a 
+startup.
+5. **Dependency to the Python stack:** Most existing tools were designed by and for data scientists that use Python 
+as their default go-to programming language, but most production apps, especially in enterprise, use JVM or .Net based stacks. This not only have an implication on the language used, but also on tooling and configuration management.
 
-Make sure you've configured it like this in your IDE (although it should be already configured because we
-checked in the settings file):
+Overall, eLLMental is designed to help software engineers efficiently build AI-driven applications by
+removing all common headaches while integrating AI into your development environment.
 
-![Save Actions Tool settings](./.docassets/format-on-save.png)
+If you want to quickly get started with the project, you can always check our guide in 
+the [official documentation](https://docs.ellmental.com/getting_started/).
 
-### Adding a new package into the monorepo
 
-1. Duplicate the `.kotlin-template` folder and rename it to your package name.
-2. Add the package name to the `settings.gradle.kts` file, in the `includes` list.
-3. ???
-4. Profit!
+# License
+
+The eLLMental project is licensed under the terms of the Apache License, Version 2.0. See the 
+[LICENSE](https://www.apache.org/licenses/LICENSE-2.0) file for details.
+
+eLLMental is an open-source initiative by [The Agile Monkeys](https://www.theagilemonkeys.com/).

website/.gitignore

@@ -0,0 +1,20 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

website/README.md

@@ -0,0 +1,29 @@
+# Website
+
+This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
+
+## Installation
+
+```
+$ npm i
+```
+
+## Local Development
+
+```
+$ npm run start
+```
+
+This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+
+## Build
+
+```
+$ npm run build
+```
+
+This command generates static content into the `build` directory and can be served using any static contents hosting service.
+
+## Deployment
+
+The deployment is automatically done through GH actions, see `.github/workflows/wf_publish-docs` for more details.

website/babel.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
+};