docs: improve discoverability of storage options - #687
Conversation
Signed-off-by: Vikram Vaswani <vvaswani@blaxel.ai>
🔍 PR Interaction AnalysisThis is a docs-only PR — no service code, APIs, or runtime components are modified. The changes add cross-references (blog post links) and clarifying notes to existing storage documentation pages. Since there are no code-level component interactions to diagram, here's a visual map of how the documentation pages are connected by this PR: sequenceDiagram
participant User as Reader
participant BP as best-practices.mdx
participant SO as Sandboxes/Overview.mdx
participant SF as Sandboxes/Filesystem.mdx
participant VO as Volumes/Overview.mdx
participant AD as Agent-drive/Overview.mdx
participant TS as troubleshooting.mdx
participant Blog as Blog Post (external)
User->>BP: Reads storage comparison table
BP-->>Blog: New link → "choosing the right storage"
User->>SO: Reads root storage / volumes section
SO-->>Blog: New link → "choosing the right storage"
User->>SF: Reads filesystem operations intro
SF-->>Blog: New link → "choosing the right storage"
User->>VO: Reads volumes overview
VO-->>Blog: New link → "choosing the right storage"
User->>AD: Reads agent drive overview
AD-->>Blog: New link → "choosing the right storage"
User->>TS: Hits ENOSPC error
TS-->>Blog: New link → benchmarks
SummaryAll 6 changed files now funnel readers toward the same external blog post for storage guidance. Additionally, Note Posted by PR Sequence Diagram · Tag @mendral-app with feedback. |
![mendral-app[bot]](https://avatars.githubusercontent.com/in/1975249?s=60&v=4){kind=small}
There was a problem hiding this comment.
Needs attention — 1 issue in 1 file
Typo "informaton" (missing 'i') is repeated in 4 of 6 files. Otherwise the changes are straightforward doc additions with no correctness or security concerns.
Prompt for AI agents (all issues)
Check if these issues are valid — if so, understand the root cause of each and fix them.
<assessment>
Typo "informaton" (missing 'i') is repeated in 4 of 6 files. Otherwise the changes are straightforward doc additions with no correctness or security concerns.
</assessment>
<file name="Agent-drive/Overview.mdx">
<issue location="Agent-drive/Overview.mdx:22">
Typo: "informaton" should be "information". This same typo is repeated in `Sandboxes/Filesystem.mdx:12`, `Sandboxes/best-practices.mdx:44`, and `Volumes/Overview.mdx:16`.
</issue>
</file>
Tag @mendral-app with feedback or questions. View session
| - Drives scale automatically with no fixed capacity limits. Pre-provisioning or run-time resizing is not required. | ||
|
|
||
| <Tip> | ||
| Refer to our [blog post on choosing the right storage for your Blaxel agents](https://blaxel.ai/blog/choose-the-right-storage-for-your-blaxel-agents) for more informaton. |
There was a problem hiding this comment.
maintainability (P3): Typo: "informaton" should be "information". This same typo is repeated in Sandboxes/Filesystem.mdx:12, Sandboxes/best-practices.mdx:44, and Volumes/Overview.mdx:16.
Suggested change
| Refer to our [blog post on choosing the right storage for your Blaxel agents](https://blaxel.ai/blog/choose-the-right-storage-for-your-blaxel-agents) for more informaton. | |
| Refer to our [blog post on choosing the right storage for your Blaxel agents](https://blaxel.ai/blog/choose-the-right-storage-for-your-blaxel-agents) for more information. |
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At Agent-drive/Overview.mdx, line 22:
<issue>
Typo: "informaton" should be "information". This same typo is repeated in `Sandboxes/Filesystem.mdx:12`, `Sandboxes/best-practices.mdx:44`, and `Volumes/Overview.mdx:16`.
</issue>
🧪 Testing GuideWhat this PR addressesThis PR improves the discoverability of storage options in the Blaxel docs by adding links to a blog post ("Choose the right storage for your Blaxel agents") across multiple storage-related pages. It also makes two small content corrections:
Steps to verify
What to verify (expected behavior)
Note Posted by PR Testing Guide · Tag @mendral-app with feedback. |
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
|
📋 Created Linear issue ENG-3925 — status: In Progress
Auto-created because no Linear reference was found in the PR title, description, or branch name. Note: branch prefix Note Posted by Linear Issue Enforcer · Tag @mendral-app with feedback. |
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
1 participant
Fixes ENG-3925
Note
Adds cross-references to a blog post about storage options across multiple documentation pages (Agent Drive, Sandboxes, Volumes, troubleshooting). Also adds a note clarifying current storage limitations and updates the comparison table to reflect that the S3 interface is "coming soon" rather than available.
Written by Mendral for commit 5e5044b.