Skip to content

Added CheerpJ extension docs (Debug & File handling)#375

Draft
rijulshrestha wants to merge 2 commits intomainfrom
CheerpJ-Extension-Docs
Draft

Added CheerpJ extension docs (Debug & File handling)#375
rijulshrestha wants to merge 2 commits intomainfrom
CheerpJ-Extension-Docs

Conversation

@rijulshrestha
Copy link
Copy Markdown
Contributor

No description provided.

@rijulshrestha rijulshrestha requested a review from epanholz March 26, 2026 12:17
@rijulshrestha rijulshrestha self-assigned this Mar 26, 2026
@epanholz
Copy link
Copy Markdown
Member

Great job already! The overall flow of the new pages is really nice and they are not too overloaded.

Debug page input:

  • I am not to happy with the title, something like "How to debug the extension" might be better
  • Please prompt users to enable the debug setting before loading the application or to reload the page after enabling the setting. Otherwise it won't take effect.
  • Please include the instructions on how to collect a console log and har file in the extension pages. Clicking to another page is annoying for users. And we need to add specific instructions for each extension. For the JNLPRunner we can prompt users to open the dev tools on the "start application" page. To make sure the logs are complete. And for the AppletRunner we need to prompt users to either reload the page after opening the dev tools or to enable the extension only after the dev tools are open. This helps with getting incomplete logs from users. It's a bit annoying that we will have such similar pages, but it can help us save some time in the long run.

File pages:

  • We can link to the explanation guide here at the top of the page
  • For the upload button we should add context that it will only be available once an applet/application is already running
  • We can also add that if users can't see the popup icon they need to ping the extension
  • Please remove mentions of JFileChooser, there is other classes that work the same. We can just mention it once like this "Java File Dialog (for example JFileChooser) and then just say File Dialog. Also the upload icon will be present on any window/frame/dialog that opens. It's part of the title bar.

Copy link
Copy Markdown
Contributor

@GabrielaReyna GabrielaReyna left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just some extra suggestions with vocabulary to avoid confusion between the local filesystem and the virtual one. More than that, very good.


1. Click the **Upload** button in the extension popup.
2. Select the file(s) from your local machine.
3. The files will be automatically placed in the **`/files/uploads/`** directory.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
3. The files will be automatically placed in the **`/files/uploads/`** directory.
3. The files will be automatically placed in the **`/files/uploads/`** virtual directory.

To import a local file to the virtual filesystem:

1. Click the **Upload** button in the extension popup.
2. Select the file(s) from your local machine.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
2. Select the file(s) from your local machine.
2. Select the file(s) from your local filesystem (your machine).


### Downloading files

Any file that the Java applet saves to the **`/files/downloads/`** directory will be automatically detected and downloaded by your browser to your local machine (usually your default Downloads folder).
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Any file that the Java applet saves to the **`/files/downloads/`** directory will be automatically detected and downloaded by your browser to your local machine (usually your default Downloads folder).
Any file that the Java applet saves to the **`/files/downloads/`** virtual directory will be automatically detected and downloaded by your browser to your local machine (usually your default Downloads folder).


1. Click the **Upload** button in the extension popup.
2. Select the file(s) from your local machine.
3. The files will be automatically placed in the **`/files/uploads/`** directory.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
3. The files will be automatically placed in the **`/files/uploads/`** directory.
3. The files will be automatically placed in the **`/files/uploads/`** virtual directory.

To import a local file to the virtual filesystem:

1. Click the **Upload** button in the extension popup.
2. Select the file(s) from your local machine.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
2. Select the file(s) from your local machine.
2. Select the file(s) from your local filesystem (your machine).


### Downloading files

Any file that the Java application saves to the **`/files/downloads/`** directory will be automatically detected and downloaded by your browser to your local machine (usually your default Downloads folder).
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Any file that the Java application saves to the **`/files/downloads/`** directory will be automatically detected and downloaded by your browser to your local machine (usually your default Downloads folder).
Any file that the Java application saves to the **`/files/downloads/`** virtual directory will be automatically detected and downloaded by your browser to your local machine (usually your default Downloads folder).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants