File system guides updated for the new upload/download functionality#374
File system guides updated for the new upload/download functionality#374rijulshrestha wants to merge 6 commits intomainfrom
Conversation
|
Overall already very happy with how this looks. Some inputs: FIlesystem guide:
I think we can just say something like this "Files imported this way will be available in the virtual /files/uploads/ directory." I think any additional context might be confusing to some users. FIlesystem support explanation: The "Specialized directories" section here looks good. Please just also add that /uploads is not persistent and we can also add a screenshot on how the upload button looks. Also you opened a draft PR, we won't be able to merge this one after review. |
|
I've added a screenshot highlighting the upload button. I'm not sure that the picture I uploaded is best suited. When I try to just zoom in the upload button it gets blurry and seems a bit weird. Open to suggestion on what should go on as a screenshot for the upload button. |
epanholz
left a comment
There was a problem hiding this comment.
Looking good already. Requested some more small changes.
sites/cheerpj/src/content/docs/14-explanation/File-System-support.md
Outdated
Show resolved
Hide resolved
| ### Method 1: Using the file picker upload button | ||
|
|
||
| The quickest way to place a file into CheerpJ’s virtual filesystem from JavaScript is `cheerpOSAddStringFile`. It’s ideal for string content and also supports binary data. | ||
| CheerpJ's built-in file picker dialog includes an **upload button** (upward arrow icon) in the top-right corner. Clicking it opens the browser's native file picker, allowing the user to select a file from their local machine. The selected file is automatically placed into **`/files/uploads/`** and becomes available to the Java application immediately. No JavaScript is required. |
There was a problem hiding this comment.
Again the upload icon is not just present on file dialogs, it's present on all windows with a title bar. Using the file dialog is often the most convenient way since users already want to interact with files. Please rewrite this a bit.
For the applet docs we might need extra context since applet window frames don't have title bars, there we can mention the file dialog. (other pr)
epanholz
left a comment
There was a problem hiding this comment.
I added one last comment about the table in the explanation. Once that is applied it's ready for merging. Good job.
Note: I will be holding off merging this until we release a new point version of CJ, which we plan to do soon.
sites/cheerpj/src/content/docs/14-explanation/File-System-support.md
Outdated
Show resolved
Hide resolved
GabrielaReyna
left a comment
There was a problem hiding this comment.
Looks good. As a minor thing, the directory tree could be added as a code block, just like we did in http://localhost:4321/docs/tutorials/swingset3 at the beginning of both guides.
|
Thanks for the suggestion. I've added a directory tree structure at the beginning of both guides. |
No description provided.