Documents

Organize project files, upload or download documents, edit metadata, and inspect how each document participates in one or more indexes.

4 min read

Folders contain the original documents used by Data Loaders, indexes, flows, and workspaces. The folder path is the stable address that connects those features.

Folder overview

From Data → Folders, select a folder name.

The overview contains:

Setting or action	What it does
Browse Documents & Files	Opens the folder tree and document list.
Add Index	Starts an index with this folder as its Data Location.
Add Loader	Starts a Data Loader with this folder as its destination.
Sync	Runs an update for that index so new, modified, or out-of-sync documents are processed.
Indexed Documents	Documents in the folder that have a current indexed version.
Total Documents	Documents selected by the index.
Needs Attention	Documents that need embeddings, are out of sync, or failed indexing.
Delete Folder	Removes an empty folder. The button is disabled while an index or loader still uses the folder.

The index card also shows its embedding model, dimensions, and text-splitter settings.

Browse and organize documents

Select Browse Documents & Files to open the folder. Select a directory name to move into it, or use .. to move to its parent.

Documents and subfolders inside a project Data folder

The document table includes:

Column	Meaning
Name	The directory or file name. Select a document to open it.
Content Type	The document MIME type, such as `text/markdown` or `application/pdf`.
Size	Stored file size.
Indexes	Whether the document is represented in one or more indexes.
Created	When the BotDojo document record was created.
Modified	When the stored document was last changed.
Actions	File-level actions such as delete, download, and edit when supported.

Use the table controls to search, filter, sort, choose visible columns, refresh the listing, or open it full screen.

Folder actions

Action	What it does
Create Folder	Adds a directory below the current path.
Add Documents → Upload Files	Uploads one or more supported files into the current folder.
Add Documents → Upload Zip	Expands one ZIP archive into the current folder while preserving its internal folder structure. This is the practical choice for a large file set.
Download	Downloads the selected file or packages selected files and folders as a ZIP.
Delete	Queues deletion for the selected files and directories.

The upload dialog displays its accepted file types. Common choices include text, Markdown, PDF, Word, Excel, and PowerPoint files. The uploader also recognizes formats such as HTML, CSV, SRT, JSON, and BotDojo Canvas documents. Files that cannot be previewed in the browser can still be downloaded and indexed when their content type is supported by the indexing pipeline.

Open a document

The document page shows the logical Path, Content Type, Created date, and Modified date. Its actions are:

Action	What it does
Edit	Opens an editor for supported text-based documents.
Download	Downloads the original file.
Delete	Removes the document after confirmation.

The page has three tabs:

Document previews the content. Markdown files can switch between Rendered and Raw views.
Metadata edits the document’s JSON metadata. Select Save to persist changes or Cancel to restore the current saved value.
Parts shows every index that contains the document and lets you inspect the chunks produced for each index.

Document metadata

BotDojo maintains system fields such as the logical path, folder, filename, content type, size, created date, and modified date. Data Loaders can add source identifiers, source URLs, tags, or provider-specific fields to the document’s meta object.

Useful fields for citations include:

reference_url: the canonical source URL.
reference_title or title: a readable label for the source.

Index parts inherit document metadata when they are built. Editing document metadata therefore affects future index updates; run the index again when the search copy should reflect the change.

For Markdown files, YAML front matter is another way to keep custom metadata with the content. See Metadata and Markdown.

Special project folders

Some BotDojo features create and manage their own folders:

chat_messages stores files supplied to flows.
Workspace and agent folders store workspace files, memory, skills, and session artifacts.
A Data Loader writes below the destination path selected in its configuration.

Treat these as normal project documents, but avoid manually renaming or deleting feature-managed paths unless you also update the feature that owns them.