docs: update Assistant documentation for recent frontend changes#652
docs: update Assistant documentation for recent frontend changes#652SangeetaMishr wants to merge 1 commit into
Conversation
… status, uploads, and cloning Reflects several assistant features shipped in glific-frontend over the last two months: - Manual assistant creation (glific-frontend#3754): creation form no longer auto-provisions a blank assistant before you fill it in - Hardcoded model options (glific-frontend#3802): model dropdown is a fixed list (gpt-4o, gpt-4o-mini, gpt-4.1, gpt-4.1-mini), not fetched from the backend - Assistant status display (glific-frontend#3829, #3836): documents the Ready / In Progress / Failed status chip in the assistant list - Queued file uploads (glific-frontend#3854): per-file progress, per-file errors and retry, save blocked on failed uploads, 20MB size limit - User-initiated assistant cloning (glific-frontend#3857): replaces the old "Copying the assistants" section - confirmation dialog, Cloning/Retry cloning button states, and the legacy-assistant eligibility restriction Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
📝 WalkthroughWalkthroughUpdated two assistant integration guides with July 2026 timestamps. The documentation now clarifies save behavior, supported model selection, knowledge-base upload states and limits, assistant cloning eligibility and progress, and failed setup status handling. 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
🚀 Deployed on https://deploy-preview-652--glific-docs.netlify.app |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/5`. Integrations/Creating and modifying assistants in Glific.md:
- Line 34: Update the headings in “Creating and modifying assistants in
Glific.md,” including “Assistant status” and the other referenced headings, so
each has exactly one blank line before and after it to satisfy markdownlint
MD022.
- Around line 28-32: Fix the ordered-list numbering around the assistant
creation steps by using consistent Markdown list prefixes, preferably `1.` for
each item, while keeping the rendered sequence as steps 3–5 and preserving the
intervening image content.
In `@docs/5`. Integrations/Filesearch Using OpenAI Assistants.md:
- Line 69: Update the Failed assistant status description in the integrations
documentation to instruct users to check the assistant details for the failure
and retry saving their changes. Keep the existing explanation about the previous
live version while making the status actionable.
- Line 7: Update the date referenced in the assistant guide’s clone-eligibility
content to match the established February 10, 2026 cutoff used in “Creating and
modifying assistants in Glific.md”, ensuring both guides are consistent.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: 4171e73c-177f-4fe5-94ef-88b41ec27249
📒 Files selected for processing (2)
docs/5. Integrations/Creating and modifying assistants in Glific.mddocs/5. Integrations/Filesearch Using OpenAI Assistants.md
| 3. Click on save. This is the point the assistant is actually created - nothing is saved to Glific until you click save here. | ||
| 4. This navigates to the assistant versions listing page. | ||
| <img width="1233" height="750" alt="Screenshot 2026-04-14 at 2 59 16 PM" src="https://github.com/user-attachments/assets/9078b2a2-24d4-4621-895b-c3f84f257caf" /> | ||
|
|
||
| 5. From here, copy the assistant id and use it in the flow. |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Fix the ordered-list numbering.
markdownlint reports MD029 because these items use 3., 4., and 5. after intervening content. Use consistent 1. prefixes or restructure the list so the rendered numbering remains sequential.
Proposed fix
-3. Click on save. This is the point the assistant is actually created - nothing is saved to Glific until you click save here.
-4. This navigates to the assistant versions listing page.
+1. Click on save. This is the point the assistant is actually created - nothing is saved to Glific until you click save here.
+1. This navigates to the assistant versions listing page.
...
-5. From here, copy the assistant id and use it in the flow.
+1. From here, copy the assistant id and use it in the flow.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| 3. Click on save. This is the point the assistant is actually created - nothing is saved to Glific until you click save here. | |
| 4. This navigates to the assistant versions listing page. | |
| <img width="1233" height="750" alt="Screenshot 2026-04-14 at 2 59 16 PM" src="https://github.com/user-attachments/assets/9078b2a2-24d4-4621-895b-c3f84f257caf" /> | |
| 5. From here, copy the assistant id and use it in the flow. | |
| 1. Click on save. This is the point the assistant is actually created - nothing is saved to Glific until you click save here. | |
| 1. This navigates to the assistant versions listing page. | |
| <img width="1233" height="750" alt="Screenshot 2026-04-14 at 2 59 16 PM" src="https://github.com/user-attachments/assets/9078b2a2-24d4-4621-895b-c3f84f257caf" /> | |
| 1. From here, copy the assistant id and use it in the flow. |
🧰 Tools
🪛 markdownlint-cli2 (0.23.0)
[warning] 28-28: Ordered list item prefix
Expected: 1; Actual: 3; Style: 1/2/3
(MD029, ol-prefix)
[warning] 29-29: Ordered list item prefix
Expected: 2; Actual: 4; Style: 1/2/3
(MD029, ol-prefix)
[warning] 32-32: Ordered list item prefix
Expected: 3; Actual: 5; Style: 1/2/3
(MD029, ol-prefix)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/5`. Integrations/Creating and modifying assistants in Glific.md around
lines 28 - 32, Fix the ordered-list numbering around the assistant creation
steps by using consistent Markdown list prefixes, preferably `1.` for each item,
while keeping the rendered sequence as steps 3–5 and preserving the intervening
image content.
Source: Linters/SAST tools
|
|
||
| 5. From here, copy the assistant id and use it in the flow. | ||
|
|
||
| ## Assistant status |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Add blank lines around headings.
markdownlint reports MD022 for these headings. Ensure each heading has a blank line before and after it.
Also applies to: 40-40, 48-48, 67-67
🧰 Tools
🪛 markdownlint-cli2 (0.23.0)
[warning] 34-34: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/5`. Integrations/Creating and modifying assistants in Glific.md at line
34, Update the headings in “Creating and modifying assistants in Glific.md,”
including “Assistant status” and the other referenced headings, so each has
exactly one blank line before and after it to satisfy markdownlint MD022.
Source: Linters/SAST tools
| <td><b>6 minutes read</b></td> | ||
| <td style={{ paddingLeft: 40 }}><b> Level: Advanced</b></td> | ||
| <td style={{ paddingLeft: 40 }}><b>Last Updated: April 2026</b></td> | ||
| <td style={{ paddingLeft: 40 }}><b>Last Updated: July 2026</b></td> |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
set -euo pipefail
file='docs/5. Integrations/Filesearch Using OpenAI Assistants.md'
# Show the relevant section with line numbers
sed -n '1,120p' "$file" | cat -n
printf '\n---\n'
# Search for the cloning eligibility wording across the repo
rg -n --hidden --no-ignore-vcs 'March 10, 2026|February 10, 2026|cloning eligibility|created before' .Repository: glific/docs
Length of output: 9514
🏁 Script executed:
#!/bin/bash
set -euo pipefail
file='docs/5. Integrations/Creating and modifying assistants in Glific.md'
sed -n '55,80p' "$file" | cat -n
printf '\n---\n'
rg -n --hidden --no-ignore-vcs 'February 10, 2026|March 10, 2026|Clone Assistant|knowledge base' 'docs/5. Integrations'Repository: glific/docs
Length of output: 5203
Align the clone-eligibility date with the assistant guide.
docs/5. Integrations/Filesearch Using OpenAI Assistants.md:83 says assistants created before March 10, 2026 are eligible, but docs/5. Integrations/Creating and modifying assistants in Glific.md uses February 10, 2026. Make the date consistent.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/5`. Integrations/Filesearch Using OpenAI Assistants.md at line 7, Update
the date referenced in the assistant guide’s clone-eligibility content to match
the established February 10, 2026 cutoff used in “Creating and modifying
assistants in Glific.md”, ensuring both guides are consistent.
| - Once the files are added, click on `Save`. This will show the status of the Assistant setup. | ||
| - Ready — assistant is live and usable | ||
| - In Progress — a new version is being prepared | ||
| - Failed — the last update didn't complete successfully; the assistant keeps running on its previous live version |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Add recovery guidance for Failed assistants.
Explain that users should check the assistant details and retry saving their changes, so the status is actionable rather than informational only.
Suggested wording
- - Failed — the last update didn't complete successfully; the assistant keeps running on its previous live version
+ - Failed — the last update didn't complete successfully; the assistant keeps running on its previous live version. Check the assistant for details and try saving your changes again.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - Failed — the last update didn't complete successfully; the assistant keeps running on its previous live version | |
| - Failed — the last update didn't complete successfully; the assistant keeps running on its previous live version. Check the assistant for details and try saving your changes again. |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/5`. Integrations/Filesearch Using OpenAI Assistants.md at line 69,
Update the Failed assistant status description in the integrations documentation
to instruct users to check the assistant details for the failure and retry
saving their changes. Keep the existing explanation about the previous live
version while making the status actionable.
2 participants
Summary
Fixes #588
Updates both AI Assistant docs ("Creating and modifying assistants in Glific" and "File Search Using OpenAI Assistants") to reflect the 5 features listed in the issue, all verified directly against the referenced frontend PR diffs rather than the issue description alone:
gpt-4o,gpt-4o-mini,gpt-4.1,gpt-4.1-mini) rather than fetching from the backend.Note on the cloning eligibility date
The issue states assistants are eligible if "Created before February 10, 2026." I couldn't find that exact date encoded anywhere in
glific/glific(eligibility is driven by aclone_statusfield that isn't "none", set via what looks like an out-of-band data migration) - I've used the date as given in the issue since I have no way to verify it independently. Flagging in case it needs correcting.Verification
Read the full diffs of all 5 referenced glific-frontend PRs (#3754, #3802, #3829, #3836, #3854, #3857) to confirm exact UI copy, button labels, and behavior rather than paraphrasing the issue.
Test plan
Summary by CodeRabbit