search

acquire-project / acquire-docs

https://acquire-project.github.io/acquire-docs/
0 stars 3 forks source link

Tutorial Organization #70

Closed dgmccart closed 2 months ago

dgmccart commented 11 months ago

We have several tutorials already on the site. To help users find what their looking for, we should organize these tutorials into larger categories.

dgmccart commented 3 months ago
Screenshot 2023-11-13 at 1 07 39 PM

Implement the design specified above with collapsible sections of the left hand side secondary navigation bar since our tutorial names are quite long. Groupings are as follows:

Tile 1 - Setup acquisition: Learn how to configure and run an acquisition trigger.md configure.md Start_stop.md select.md setup.md drivers.md storage.md

Tile 2 - Using JSON: Learn how to save and retrieve acquisition settings Trigger: trig_json.md Properties: prop_json.md

Tile 3 - Data: Learn how to access data during acquisition Accessing data: framedata.md livestream.md

Tile 4 - Zarr: Learn about using OME-Zarr with Acquire multiscale.md chunked.md compressed.md

If those tiles will link to landing pages, we can reuse the copy from the main tutorial homepage and replacing the first sentence with the verbiage from the tile description. E.g. for the setup acquisition tile:

"These tutorials will help you learn how to configure and run an acquisition. Please submit an issue on Github if you'd like to request a tutorial, or if you are also interested in contributing to a tutorial to this documentation please visit our contribution guide."

A simple list of the tutorial titles that hyperlinks to their pages would be sufficient.

dgmccart commented 2 months ago

The same tile setup as the homepage was used, and the exact specifications in the above screenshot were not necessarily followed.