Skip to content

[feat]: Remove contradictions in documentation #332

Description

@TheWojtek

Describe the feature you'd like to request

Can we finally remove the contradictions and falsehoods in the documentation which make the installation and uninstallation a hit or miss?

Unclear, misleading or plainly erroneous install instructions:
https://github.com/nextcloud/context_chat_backend#install

First paragraph, first sentence:

Be mindful to install the backend before the Context Chat php app

Backend first, then the app.

Second paragraph:

Install the given apps for Context Chat to work as desired in the given order

AppAPI from the Apps page
→ [Context Chat (same major and minor version as the backend) from the Apps page]
→ [Context Chat Backend (same major and minor version as Context Chat app) from the Apps page]

App first, then the backend.

So the "given order" is clearly different from what was recommended just one paragraph earlier. Which one is correct?

Turns out, the very next sentence in the 1st paragraph explains... the first sentence does not matter:

"Context Chat php app would sends (sic!) all the user-accessible files to the backend for indexing in the background. It is not an issue even if the request fails to an uninitialised backend"

So there is no apparent reason nor need to install the Context Chat php app in the given order. Why complicate things?

→ [Context Chat Backend (same major and minor version as Context Chat app) from the Apps page]

No, there is no Context Chat Backend on the Apps page. No Nextcloud instance I know of can find this app in the internal App Store. This is misleading. Currently, the only way to install this app without resorting to manual Docker installation is using occ app_api:app:register context_chat_backend. This misleading information is repeated in https://docs.nextcloud.com/server/latest/admin_manual/ai/app_context_chat.html as well

Unclear, misleading or plainly erroneous uninstall instructions:

Currently, the only half-reliable way of uninstalling the context_chat_backend is by using occ app_api:app:unregister context_chat_backend (often with --force). This, however, does not remove the data from the Nextcloud database and a reinstall uses data from previous installations, so all the issues (like files not being indexed) will persist. Since there is no way to force a reindex from within the Nextcloud instance, either a script to remove all traces of context_chat_backend and context_chat is needed, or clear instructions on what to remove from the database in order to start completely clean again.

Describe the solution you'd like
A documentation written in a manner that actually helps.

Describe alternatives you've considered
Nuking this whole trainwreck from my servers and looking for an alternative.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions