Re-write of docs/usage.md

[ns-rse]

Closes #180

Re-writes the docs/usage page of the website with description and screenshots for using mesnage-org.github.io/pgfinder-gui.

[codecov]

Codecov Report

Patch coverage has no change and project coverage change: -1.47% ⚠️

Comparison is base (8435a77) 71.02% compared to head (e97fccc) 69.56%.
Report is 55 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #184      +/-   ##
==========================================
- Coverage   71.02%   69.56%   -1.47%     
==========================================
  Files           8       10       +2     
  Lines         535      552      +17     
==========================================
+ Hits          380      384       +4     
- Misses        155      168      +13     

see 7 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[smesnage]

Do you have the equivalent document for the original myBinder?
I can give it a shot once I know what you're after, especially how much details are needed.
Sorry you have to tell me everyting!

[TheLostLambda]

On a quick glance, this looks great! I'll take a closer look in the next few days!

[ns-rse]

Do you have the equivalent document for the original myBinder?
I can give it a shot once I know what you're after, especially how much details are needed.

The current documentation has the JupyterLite version which really just replaced the screenshots so they aligned, see here.

You can see a crude example of how it renders in HTML here which includes the text and in-line images.

Sorry you have to tell me everything!

Not a problem at all, its really useful to have your feedback.

On a quick glance, this looks great! I'll take a closer look in the next few days!

Cool, no rush, just had some time where I need something relaitvely mindless to do so figured I'd go through, take some screenshots and have a go at re-writing the text. Feedback welcome. 😄

[TheLostLambda]

Still needs an even deeper look, but I don't know if any of the cache-clearing stuff is still valid. Pyodide doesn't actually seem to cache anything by default — I think that was JupyterLite playing intentionally with IndexedDB. I'm thinking about adding the cache back, but with an explicit check / hash of the pip package info so it's invalidated every time PGFinder is updated!

[ns-rse]

Still needs an even deeper look, but I don't know if any of the cache-clearing stuff is still valid. Pyodide doesn't actually seem to cache anything by default — I think that was JupyterLite playing intentionally with IndexedDB.

Checked https://mesnage-org.github.io/pgfinder-gui/ from Firefox, Opera and Chromium

• Firefox says there isn't anything being stored by the site.
• Opera not clear, but takes a while to load mass libraries and options suggesting they're not cached.
• Chromium not clear, but again takes a while to load mass libraries and options suggesting they're not cached.

I found this thread which points to this article on WASM caching but my (crude) understanding is that caching WASM wouldn't be a problem.

I'm thinking about adding the cache back, but with an explicit check / hash of the pip package info so it's invalidated every time PGFinder is updated!

That would be neat, although I think a more general solution would be if we could include the ability in pgfinder-gui for users to select what version they run against if that is at all possible. An issue for a different repo perhaps, not sure if we should aim to include it prior to submission of JOSS (can always keep adding things!).

[ns-rse]

Removed reference to clearing cache, if no other comments or tweaks this is ready to merge.

[TheLostLambda]

I think it looks great! Only thing is that a couple of GUI tweaks in the next few days might warrant new screenshots, but those can be a second PR if you'd prefer!

…

On Tue, 15 Aug 2023, 15:01 Neil Shephard, ***@***.***> wrote: Removed reference to clearing cache, if no other comments or tweaks this is ready to merge. — Reply to this email directly, view it on GitHub <#184 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ABPWK25D3W6TRHK5XCCPTGTXVN6MFANCNFSM6AAAAAA2XB5PLQ> . You are receiving this because your review was requested.Message ID: ***@***.***>

[ns-rse]

I think it looks great! Only thing is that a couple of GUI tweaks in the next few days might warrant new screenshots, but those can be a second PR if you'd prefer!

Great, I'll merge this, we can tweak in the future. Not a fan of PRs dragging out, counter to the idea that commits should be small.