SG-4373 Improve documentation about local file references#389
Merged
julien-lang merged 4 commits intoJul 14, 2025
Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR updates documentation for local file link handling by refining the 'local_storage' schema and enhancing the file attachment examples.
- Updated the 'local_storage' structure in the API reference with detailed keys.
- Revised the attachments documentation to clarify the use of local paths vs. relative paths and improve code examples.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/reference.rst | Updated the 'local_storage' schema with explicit keys and improved formatting. |
| docs/cookbook/attachments.rst | Revised text and examples for file attachments, including minor typo fixes and code formatting improvements. |
Comments suppressed due to low confidence (1)
docs/reference.rst:809
- The inline 'TODO' comment appears to be left unintentionally. Consider removing or clarifying it.
'name': "string" | Pass, TODO
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
julien-lang
changed the title
eduardoChaucaGallegos
previously approved these changes
Jun 5, 2025
carlos-villavicencio-adsk
previously approved these changes
Jun 6, 2025
carlos-villavicencio-adsk
left a comment
carlos-villavicencio-adsk
left a comment
Contributor
There was a problem hiding this comment.
LGTM. Two nitpick suggestions only.
Co-authored-by: Carlos Villavicencio <123113322+carlos-villavicencio-adsk@users.noreply.github.com>
julien-lang
dismissed stale reviews from carlos-villavicencio-adsk and eduardoChaucaGallegos
via
53b4e21
carlos-villavicencio-adsk
approved these changes
Jun 12, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request updates the documentation for handling local file fields and local storage references.
relative_pathandlocal_storagefieldsLocalStorageby name