Skip to content

docs(ai/assistant): document the assistant data folder name - #15527

Merged
skjnldsv merged 1 commit into
nextcloud:masterfrom
bakiburakogun:docs/assistant-data-folder
Sep 16, 2026
Merged

skjnldsv merged 1 commit into
nextcloud:masterfrom
bakiburakogun:docs/assistant-data-folder

Conversation

@bakiburakogun

Copy link
Copy Markdown
Contributor

Documents the assistant data folder name, added in nextcloud/assistant#632.

The assistant creates a folder in each user's files for the content it generates — generated images, speech-to-text output. Its name used to be a constant; it is now an app config value with a per-user override, and both are editable in the admin and personal settings. Neither the keys nor the behaviour around existing folders was written down anywhere.

Added as item 5 of the existing "Assistant configuration" list, covering:

  • occ config:app:set assistant default_data_folder for the server-wide default,
  • occ user:setting $USER_ID assistant data_folder for the per-user value,
  • that changing either does not rename or move folders that already exist,
  • that a user who already has a folder under the built-in Assistant name keeps it, instead of getting a second folder and leaving their earlier output behind.

The last two are the parts that surprise people, so they seemed worth stating rather than leaving to be discovered.

Note that the app change is merged but not in a release yet, so this targets master only — happy to follow up with backports once it ships.

@github-actions

Copy link
Copy Markdown
Contributor

Hello there,
Thank you so much for taking the time and effort to create a pull request to our Nextcloud project.

We hope that the review process is going smooth and is helpful for you. We want to ensure your pull request is reviewed to your satisfaction. If you have a moment, our community management team would very much appreciate your feedback on your experience with this PR review process.

Your feedback is valuable to us as we continuously strive to improve our community developer experience. Please take a moment to complete our short survey by clicking on the following link: https://cloud.nextcloud.com/apps/forms/s/i9Ago4EQRZ7TWxjfmeEpPkf6

Thank you for contributing to Nextcloud and we hope to hear from you soon!

(If you believe you should not receive this message, you can add yourself to the blocklist.)

@kyteinsky kyteinsky left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

would be nice to document this in the user manual too: https://github.com/nextcloud/documentation/blob/master/user_manual/ai_assistant.rst

but the changes look good!

The assistant creates a folder in each user's files for the content it
generates. Its name is now configurable server-wide and per user, but neither
the key nor the behaviour around existing folders was written down anywhere.

Documents both settings next to the other assistant occ options, and the two
things that surprise people: changing the name leaves existing folders alone,
and a user who already has a folder under the built-in name keeps it rather
than getting a second one.

Adds the user facing side to the user manual as well: where the assistant saves
what it generates, that the name can be changed in the personal settings, and
that changing it leaves the existing folder alone. The skills path is stated
relative to that folder rather than hardcoded, since the skills folder is
resolved inside it.

Signed-off-by: Baki Burak Öğün <63836730+bakiburakogun@users.noreply.github.com>
@bakiburakogun
bakiburakogun force-pushed the docs/assistant-data-folder branch from a4eff32 to c7f04f6 Compare September 15, 2026 11:47
@bakiburakogun

Copy link
Copy Markdown
Contributor Author

Added, thanks — user_manual/ai_assistant.rst now covers it from the user's side: where the assistant saves what it generates, that the folder is called Assistant unless the administrator picked another name for the instance, that it can be renamed under Data folder in the personal settings with the placeholder showing the instance default, and the note that renaming it leaves the folder you already have alone.

One thing I ran into while writing it. The skills section said personal skills live under Assistant/Context Agent/Skills/, but AgentSkillsService::getSkillsFolder() resolves Context Agent/Skills inside getAssistantDataFolder(), so that path only holds while the folder still has its default name. I have stated it relative to the data folder and kept the default spelling as the example, so the folder tree and the weekly-report-format example below it still read the same way.

I also rebased onto master, since the branch had drifted 153 commits behind. Same single commit, and the added and removed lines are identical to before the rebase.

@kyteinsky kyteinsky left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

perfect, thanks!

@kyteinsky

Copy link
Copy Markdown
Contributor

yeah the example paths in skills section are fine, users can deduce "Assistant/" means the Assistant's folder if they renamed it, the comment at the top clarifies it too with your change.

@bakiburakogun

Copy link
Copy Markdown
Contributor Author

The build jobs had not run yet when you approved this — they were still sitting in the queue. They have finished since: Lint RST files, Building user_manual HTML, Building admin_manual HTML and Build index.html are all green, along with Check spelling.

That leaves 21 passed, 4 skipped and one red, and the red one is Deploy Netlify preview — the same fork job you opened the issue for yesterday.

No rush from my side, just flagging it since the state changed after your review.

@skjnldsv
skjnldsv merged commit a76c85b into nextcloud:master Sep 16, 2026
25 of 26 checks passed
@kyteinsky

Copy link
Copy Markdown
Contributor

/backport to stable35

@kyteinsky

Copy link
Copy Markdown
Contributor

/backport to stable35

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants