Skip to content

docs(chat): consolidated Chat introduction updates from 10 drafter PRs#610

Draft
jordanc-relevanceai wants to merge 15 commits into
mainfrom
docs-merge/chat-intro
Draft

docs(chat): consolidated Chat introduction updates from 10 drafter PRs#610
jordanc-relevanceai wants to merge 15 commits into
mainfrom
docs-merge/chat-intro

Conversation

@jordanc-relevanceai
Copy link
Copy Markdown
Collaborator

@jordanc-relevanceai jordanc-relevanceai commented May 5, 2026

This PR consolidates 10 drafter PRs that all edit get-started/chat/introduction.mdx (plus a few sibling files). Each section below is the original description from a source PR. Opening as draft for review before closing the source PRs.

Source PRs (kept open until confirmed)

How this was assembled

Cherry-picked all 10 source branches in chronological order. Git auto-merged each cleanly because the additions land in distinct line ranges of the same file. Made one cleanup edit afterwards: moved a "see Project files" cross-link from inside the markdown editor section back to the Project files and folders section where it belongs (cherry-picks misplaced it because later additions inserted between #562's anchor point and its trailing link).

Areas that need a careful read

  • The page is now ~190 lines longer. Worth a structural pass: file-related sections (project files, text selection, agent-created files, file viewer, version history) are spread out with formatting and feedback sections between them. A future PR could reorder for better topic flow.
  • One TODO comment remains in the file viewer section ({/* TODO: Add screenshot of the conflict resolution modal dialog */}) — carry-over from docs(TSP-1111): add file viewer and conflict resolution docs to Chat #559.

#533 — TSP-1084: Document expanded file preview support in Chat

Summary

  • Adds a new "File preview capabilities" subsection to the "Supported file types in Chat" section in get-started/chat/introduction.mdx
  • Documents support for previewing 70+ file types directly in the Chat UI, with examples across PDFs, images, videos, spreadsheets, and code files
  • Notes that files without extensions (e.g. Dockerfile) are treated as plain text
  • Clarifies the distinction between file preview (UI rendering) and file processing (LLM capabilities), which remains provider-dependent

Documents expanded file preview support (70+ file types) in Chat interface following PR #1920 in relevance-chat-app. Clarifies distinction between file preview (UI) and file processing (LLM capabilities).

Test plan

  • Verify the new subsection renders correctly in Mintlify preview
  • Check that the Note callout renders without issues
  • Confirm sentence case on all headings
  • Confirm no banned words used

Linear: https://linear.app/relevance/issue/TSP-1084/


#550 — docs(TSP-1101): document text selection context feature in Chat file viewer

Summary

  • Adds a new 'Selecting text from files' section to the Chat introduction page
  • Documents how users can highlight text in the Chat file viewer and attach it as structured context to messages
  • Covers step-by-step instructions (highlight, optional note, add to message, dismiss pill) and usage guidance on when to prefer text selection over full-file attachment

Linear: https://linear.app/relevance/issue/TSP-1101/


#551 — docs(TSP-1102): expand project files section to cover folder @mentions

Summary

  • Expands the minimal "Project files" section in get-started/chat/introduction.mdx into a comprehensive "Project files and folders" section
  • Documents both individual file @mentions and the new folder @mentions feature (added in PR 1937 of relevance-chat-app)
  • Adds a comparison table clarifying the difference between @mentions, file attachments, and knowledge sources

Changes

  • Renamed section heading to "Project files and folders"
  • Added intro paragraph explaining how @mentions work and why they're useful
  • Added Info callout distinguishing @mentions from attachments and knowledge sources
  • Documented step-by-step instructions for referencing individual files
  • Documented step-by-step instructions for referencing entire folders (new feature)
  • Added Warning callout about context limits with large folders
  • Added comparison table: file @mention vs folder @mention vs attachment vs knowledge source
  • Added Tip showing how to combine file and agent @mentions

Test plan

  • Verify section renders correctly in Mintlify preview
  • Confirm all headings are in sentence case
  • Confirm no broken links or anchor references

Linear: https://linear.app/relevance/issue/TSP-1102/


#552 — docs(TSP-1104): document Files updated bar for agent-created files

Summary

  • Adds a new Viewing agent-created files section to get-started/chat/introduction.mdx, documenting the Files updated bar that appears when an agent writes or modifies files, and the View files button that opens the file viewer
  • Adds a brief cross-reference to that section in build/agents/give-your-agent-tasks/interact-with-your-agent.mdx under the Agent Chat key features

Linear issue

https://linear.app/relevance/issue/TSP-1104/

Test plan

  • Verify new section renders correctly in Mintlify preview
  • Verify anchor link resolves correctly
  • Check sentence case on all headings

#559 — docs(TSP-1111): add file viewer and conflict resolution docs to Chat

Summary

  • Added a new File viewer and editing section to the Chat introduction page, documenting the file viewer feature and its conflict resolution behavior
  • Updated the Project files section with a cross-link to the new section

Changes

get-started/chat/introduction.mdx

  • Added cross-reference link in "Project files" section pointing to the new section
  • New "File viewer and editing" section (after "Project files", before "Providing feedback on responses") covering:
    • Brief intro to opening and editing project files in Chat
    • Conflict resolution when an agent writes to a file the user has open:
      • With unsaved changes: modal with "Save your edits" / "Load agent's version" options
      • Without unsaved changes: silent auto-refresh
    • Placeholder comment for screenshot of the conflict modal (to be added later)

References


#561 — docs(TSP-1113): add markdown editor formatting features to Chat intro

Summary

  • Adds a new "Formatting your messages" section to the Chat introduction page
  • Documents the slash command menu (/) with its 9 formatting options (headings, lists, blockquotes, code blocks, dividers, table of contents)
  • Documents the table of contents block — a live, clickable outline that auto-updates as headings change
  • Section inserted between "Project files" and "Providing Feedback on Responses" to match logical page flow

Linear issue

https://linear.app/relevance/issue/TSP-1113/

Context

Features from RelevanceAI/relevance-chat-app#2000.


#562 — docs(TSP-1114): add filesystem browser documentation for Chat

Summary

  • Adds new page /get-started/chat/project-files documenting the filesystem browser feature in Chat
  • Documents the new grid view (Finder-style icon layout) added in PR #2015, alongside the existing list/tree view
  • Covers breadcrumb navigation, right-click file operations (open, download, copy path, rename, delete), and how to reference files in chat using @
  • Updates introduction.mdx to link to the new page from the existing Project files section
  • Adds get-started/chat/project-files to docs.json navigation under the Chat section

Test plan

  • New page renders correctly at /get-started/chat/project-files
  • Link from introduction page resolves correctly
  • Page appears in sidebar navigation under Chat
  • All headings are sentence case
  • No broken internal links

Linear issue: https://linear.app/relevance/issue/TSP-1114/


#566 — docs(TSP-1127): add recent meeting chat links to Chat introduction

Summary

  • Adds a new "Recent meeting chat links (desktop app)" section to the Chat introduction page
  • Documents the feature that shows up to 5 recent meeting chat links on the desktop app home/idle view
  • Covers displayed info (platform icon, meeting title, timestamp), session persistence, and how to use the links
  • Includes a note that this is a desktop-only feature

Changes

  • get-started/chat/introduction.mdx — new section inserted after "Managing sidebar panels" and before "Using Agents in Chat"

References

Test plan

  • Section appears in correct position in the page
  • Note callout renders correctly
  • Heading follows sentence case convention
  • No broken links introduced

#567 — docs(TSP-1125): add Edge region selection docs for Chat app

Summary

  • Added a new section "Selecting an Edge region in Chat" to admin/project-management/switch-projects.mdx explaining that Edge regions appear in the project switcher with an (Edge) label, listing US Edge, AU Edge, and EU Edge, and providing step-by-step instructions for selecting them
  • Added a new FAQ entry "What are Edge regions and how do I select them?" to get-started/chat/introduction.mdx pointing users to the switch-projects page for full instructions

Test plan

  • Verify the new section renders correctly on the switch-projects page
  • Verify the new FAQ accordion expands and the internal link resolves correctly
  • Check all headings are in sentence case
  • Confirm no banned words used

Linear: https://linear.app/relevance/issue/TSP-1125/


#568 — docs(TSP-1126): add file version history section to Chat

Summary

  • Adds a new File version history section to get-started/chat/introduction.mdx, positioned after "Project files" and before "Providing Feedback on Responses"
  • Documents the right-click context menu interaction for opening the Version History dialog
  • Covers browsing past versions (with dates and file sizes), previewing version content, and restoring a previous version
  • Includes a <Tip> callout emphasising that restoring a version preserves all history — no versions are deleted
  • Notes that open file tabs auto-refresh after a restore

Linear issue

https://linear.app/relevance/issue/TSP-1126/

Test plan

  • Verify the new section renders correctly in Mintlify preview
  • Confirm all headings are in sentence case
  • Confirm no broken internal links

Linear

github-actions Bot and others added 11 commits May 5, 2026 14:55
Adds a 'File preview capabilities' subsection to the supported file
types section, covering the 70+ file types now previewable in the Chat
UI. Clarifies the distinction between file preview (UI rendering) and
file processing (LLM capabilities).

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…viewer

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Expands the minimal "Project files" section into a comprehensive
"Project files and folders" section documenting both individual file
and folder @mentions in Chat.

- Renames section to "Project files and folders"
- Adds intro explaining how @mentions work and what they're for
- Documents step-by-step how to reference individual files
- Documents the new folder @mentions feature (from PR #1937)
- Adds comparison table: file @mention vs folder @mention vs attachment vs knowledge source
- Clarifies distinction between @mentions, attachments, and knowledge sources

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Add a new 'Viewing agent-created files' section to the Chat introduction
page explaining the Files updated bar and View files button. Add a brief
cross-reference to this section in the Agent Chat interact page.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…intro

Documents the new file viewer and editing feature in Chat, including the
conflict resolution behavior when an agent writes to a file the user has open.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- Create new page at get-started/chat/project-files documenting the
  filesystem browser feature, including list and grid view modes,
  breadcrumb navigation, right-click file operations, and integration
  with @ mention in Chat
- Add grid view (PR #2015) as a documented view option with persistence
- Update introduction.mdx to link to the new project files page
- Add project-files to docs.json navigation under the Chat section

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…ction

Documents the new desktop app feature that displays up to 5 recent
meeting chat links on the idle/home view, including platform icons,
meeting titles, timestamps, and session persistence.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Documents the US Edge, AU Edge, and EU Edge regions available in the
Chat browser extension and desktop app project switcher, including how
to identify them by the '(Edge)' label and a new FAQ entry.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Documents the new right-click context menu feature for file version
management in the Chat filesystem panel, including how to access
version history, preview previous versions, and restore them.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Cherry-picks from #562 placed a "see Project files" link at the end of
its filesystem browser content; with the markdown editor section from
#561 layered on top, the link ended up inside the "Formatting your
messages" section. Moved it to the end of "Project files and folders"
where it belongs.
@jordanc-relevanceai jordanc-relevanceai added the docs-drafter Documentation drafted by Claude label May 5, 2026
@mintlify
Copy link
Copy Markdown
Contributor

mintlify Bot commented May 5, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
relevanceai 🟢 Ready View Preview May 5, 2026, 4:58 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

…nt to sub-pages

Rewrites the Chat introduction to match the SGTM overview pattern: concise
intro, CardGroup feature grid for sub-page routing, no section dividers.
Moves sidebar panels, message formatting, and response feedback sections
to their respective sub-pages to keep the overview focused.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Replaces the standalone LLM section with a Getting started section
matching the SGTM overview pattern. Removes the LLM selection card
from the feature CardGroup.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
NiamhRelevance and others added 2 commits May 13, 2026 11:53
…inology

Split bloated Chat introduction into dedicated subpages (using-agents, faq)
matching the Super GTM documentation pattern. Fix terminology across Chat
docs: SuperAgent → Super GTM, filesystem browser → Files tab. Add agent
visibility section with screenshot to using-agents page. Remove YouTube
section from intro.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs-drafter Documentation drafted by Claude

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants