[PR #304] [MERGED] docs(flows): document flow-scoped Files tab, sources, and current limits #310

New Issue

2026-06-06T22:10:09-04:00

yindo commented

2026-06-06 22:10:09 -04:00

📋 Pull Request Information

Original PR: https://github.com/vxcontrol/pentagi/pull/304
Author: @mason5052
Created: 5/7/2026
Status: ✅ Merged
Merged: 5/21/2026
Merged by: @asdek

Base: feature/next-release ← Head: codex/issue-193-flow-file-upload-docs

📝 Commits (2)

e869445 docs(flows): document flow-scoped Files tab, sources, and current limits
ad7d2b1 docs(flows): refine prompt block, snapshot source, and filename limit wording

📊 Changes

1 file changed (+21 additions, -0 deletions)

View changed files

📝 README.md (+21 -0)

📄 Description

Summary

Adds a How-to subsection to the README that documents the per-flow Files tab as it ships today, so new users can find, upload, attach, and clean up flow-scoped files from the UI without reading the source.

Problem

Issue #193 covers the user-visible side of flow-scoped file uploads. The feature itself was merged in PR #272 and has since gained user resources, container pull, and save-as-resource promotion, but the README only mentions flows in general terms. New users have to read frontend, REST, and storage code to learn:

where uploaded files live on disk and inside the container,
which UI controls exist,
how the assistant sees uploaded files in its prompt,
which limits and lifecycle behaviors apply today.

Solution

Add a single new subsection 5. Manage flow-scoped files under How to Use PentAGI After Login, mirroring the style of the existing flow / templates / monitoring / assistant subsections. The new section covers:

The three file sources in the Files tab (uploads, resources, container snapshots) with the exact UI labels.
The on-host layout under {dataDir}/flow-{id}-data/ and the corresponding container paths /work/uploads and /work/resources.
Per-file actions: Download, Copy path, Save as resource, Delete, and the disabled-state tooltip on Pull file or directory from container.
Automatic injection of uploads and resources into agent system prompts via the {{.UserFiles}} template variable, which renders a compact <task_files> XML block with nested <uploads> and <resources> sections, so it is clear how the assistant sees the files.
Current limits (300 MB / 1000 files / 2 GB / 255 bytes (roughly 255 ASCII characters) per file name) and current limitations, including that flow deletion does not yet archive or remove the flow's data directory on disk.

The change is documentation only. No runtime, schema, lifecycle, or queueing behavior is introduced.

User Impact

New users can configure and use the Files tab from the README without diving into backend/pkg/server/services/flow_files.go or frontend/src/features/flows/files/.
Operators see the on-host directory layout and the current cleanup gap on flow deletion documented honestly, so they can plan disk hygiene.
The PR is intentionally a follow-up to #272, not an attempt to close #193 by itself; the remaining archive-on-deletion work is mentioned as a current limitation rather than papered over.

Test Plan

Markdown renders cleanly (no broken anchor, list, or code-fence syntax).
All UI labels and tooltips quoted in the new section match the strings in frontend/src/features/flows/files/flow-files.tsx and frontend/src/features/flows/flow-tabs.tsx on feature/next-release.
Storage layout, container paths, and limits match backend/pkg/flowfiles/files.go and backend/pkg/server/services/flow_files.go on feature/next-release.
No code or tests changed; git diff --stat shows only README.md.

Refs #193

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/vxcontrol/pentagi/pull/304 **Author:** [@mason5052](https://github.com/mason5052) **Created:** 5/7/2026 **Status:** ✅ Merged **Merged:** 5/21/2026 **Merged by:** [@asdek](https://github.com/asdek) **Base:** `feature/next-release` ← **Head:** `codex/issue-193-flow-file-upload-docs` --- ### 📝 Commits (2) - [`e869445`](https://github.com/vxcontrol/pentagi/commit/e86944543015d28c41fb64f99cf95190fabfe4fe) docs(flows): document flow-scoped Files tab, sources, and current limits - [`ad7d2b1`](https://github.com/vxcontrol/pentagi/commit/ad7d2b12ce023e8786be58c977a36fb64ba5a0c8) docs(flows): refine prompt block, snapshot source, and filename limit wording ### 📊 Changes **1 file changed** (+21 additions, -0 deletions) <details> <summary>View changed files</summary> 📝 `README.md` (+21 -0) </details> ### 📄 Description ## Summary Adds a How-to subsection to the README that documents the per-flow **Files** tab as it ships today, so new users can find, upload, attach, and clean up flow-scoped files from the UI without reading the source. ## Problem Issue #193 covers the user-visible side of flow-scoped file uploads. The feature itself was merged in PR #272 and has since gained user resources, container pull, and save-as-resource promotion, but the README only mentions flows in general terms. New users have to read frontend, REST, and storage code to learn: - where uploaded files live on disk and inside the container, - which UI controls exist, - how the assistant sees uploaded files in its prompt, - which limits and lifecycle behaviors apply today. ## Solution Add a single new subsection ``5. Manage flow-scoped files`` under ``How to Use PentAGI After Login``, mirroring the style of the existing flow / templates / monitoring / assistant subsections. The new section covers: - The three file sources in the **Files** tab (uploads, resources, container snapshots) with the exact UI labels. - The on-host layout under ``{dataDir}/flow-{id}-data/`` and the corresponding container paths ``/work/uploads`` and ``/work/resources``. - Per-file actions: **Download**, **Copy path**, **Save as resource**, **Delete**, and the disabled-state tooltip on **Pull file or directory from container**. - Automatic injection of uploads and resources into agent system prompts via the ``{{.UserFiles}}`` template variable, which renders a compact ``<task_files>`` XML block with nested ``<uploads>`` and ``<resources>`` sections, so it is clear how the assistant sees the files. - Current limits (300 MB / 1000 files / 2 GB / 255 bytes (roughly 255 ASCII characters) per file name) and current limitations, including that flow deletion does not yet archive or remove the flow's data directory on disk. The change is documentation only. No runtime, schema, lifecycle, or queueing behavior is introduced. ## User Impact - New users can configure and use the Files tab from the README without diving into ``backend/pkg/server/services/flow_files.go`` or ``frontend/src/features/flows/files/``. - Operators see the on-host directory layout and the current cleanup gap on flow deletion documented honestly, so they can plan disk hygiene. - The PR is intentionally a follow-up to #272, not an attempt to close #193 by itself; the remaining archive-on-deletion work is mentioned as a current limitation rather than papered over. ## Test Plan - [x] Markdown renders cleanly (no broken anchor, list, or code-fence syntax). - [x] All UI labels and tooltips quoted in the new section match the strings in ``frontend/src/features/flows/files/flow-files.tsx`` and ``frontend/src/features/flows/flow-tabs.tsx`` on ``feature/next-release``. - [x] Storage layout, container paths, and limits match ``backend/pkg/flowfiles/files.go`` and ``backend/pkg/server/services/flow_files.go`` on ``feature/next-release``. - [x] No code or tests changed; ``git diff --stat`` shows only ``README.md``. Refs #193 --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

yindo added the pull-request label 2026-06-06 22:10:09 -04:00

yindo closed this issue

2026-06-06 22:10:10 -04:00

yindo referenced this issue

2026-06-06 22:10:11 -04:00

[PR #318] [MERGED] docs(llm): clarify Vertex AI configuration options #313

yindo referenced this issue

2026-06-06 22:10:11 -04:00

[PR #319] [MERGED] Release 2.1.0: User Resources & Flow Files, Knowledge Base, ToolCall Logging, Assistant Flow Control, and Frontend Modernization #317

yindo referenced this issue

2026-06-06 22:10:14 -04:00

[PR #331] docs: add native Google Vertex AI provider RFC #326