zJoule is an Open Source AI assistant plugin for Eclipse designed to integrate the SAP AI Core Generative AI Hub foundation-models into your development environment.
Important
This repository provides a website with download options, guidelines and other information related to this Eclipse AI Assistant. If you are looking for the actual plugin, this is the place.
This project provides:
- A central reference for everything related to zJoule.
- Eclipse
updatesiteto allow users to download the plugin through the "install new software" functionality or the Eclipse Market Place. JavaDocwebsite created for each version of the zJoule available.
Each new release artifact should be added with its respective version folder in the docs directory. Example: v1.0.0.
The website provided uses MkDocs with the Material theme. This means all dev files are going to be located at the docs folder.
Once the project passes through the build phase, the website should be available through the public folder of the gh-pages branch. This enables GitHub Pages to expose the central website, the plugin and the JavaDoc's through the same domain configured in the repository with a single setup.
Contributions are welcome! Here's how you can get involved:
- Report Issues: Found a bug or have a feature request? Open an issue.
- Submit Pull Requests: Fork the repository, create a new branch, make your changes, and submit a PR.
- Improve Documentation: Help us improve the README or add examples to make setup easier.
- Test & Feedback: Try this Eclipse AI Assistant and give us feedback to improve them.
Please follow the contribution guidelines for more details.
Use this repository for issues and information related to the website. If you want to provide feedback related to a plugin functionality, please refer to this project repo.
Copyright (c) 2024 Nicholas Coutinho Checan.
Licensed under the MIT License. See LICENSE.