(bump:minor) Feat: Add mechanism for user-site update and auto creating releases (#56)

* move flowsettings.py and launch.py to root

* update docs

* sync sub package versions

* rename launch.py to app.py and make run scripts work with installation package

* add update scripts

* auto version for root package

* rename authors and update doc dir

* Update auto-bump-and-release.yaml to trigger on push to main branch

* latest as branch instead of tag

* pin deps versions

* cache the changelogs
This commit is contained in:
ian_Cin
2024-05-15 16:34:50 +07:00
committed by GitHub
parent eb198e0ff3
commit 654501e01c
20 changed files with 596 additions and 145 deletions

11
docs/about.md Normal file
View File

@@ -0,0 +1,11 @@
# About Kotaemon
An open-source tool for chatting with your documents. Built with both end users and
developers in mind.
[Source Code](https://github.com/Cinnamon/kotaemon) |
[Live Demo](https://huggingface.co/spaces/lone17/kotaemon-app)
[User Guide](https://cinnamon.github.io/kotaemon/) |
[Developer Guide](https://cinnamon.github.io/kotaemon/development/) |
[Feedback](https://github.com/Cinnamon/kotaemon/issues)

View File

@@ -19,7 +19,7 @@ Download and upzip the latest version of `kotaemon` by clicking this
2. Enable All Applications and choose Terminal.
3. NOTE: If you always want to open that file with Terminal, then check Always Open With.
4. From now on, double click on your file and it should work.
- Linux: `run_linux.sh`. If you are using Linux, you would know how to run a bash script, right ?
- Linux: `run_linux.sh`. Please run the script using `bash run_linux.sh` in your terminal.
2. After the installation, the installer will ask to launch the ktem's UI, answer to continue.
3. If launched, the application will be open automatically in your browser.

View File

@@ -8,7 +8,7 @@ At high level, to add new indexing and reasoning pipeline:
`BaseComponent`.
2. You declare that class in the setting files `flowsettings.py`.
Then when `python launch.py`, the application will dynamically load those
Then when `python app.py`, the application will dynamically load those
pipelines.
The below sections talk in more detail about how the pipelines should be