Test/diataxis#77
Open
beniroquai wants to merge 2 commits into
Open
Conversation
- Merging "Didaktikkonzept", the old German and English and other docs into one docuemnt - Following Diataxis concept of howtos, tutorials,e tc.
There was a problem hiding this comment.
Pull request overview
This PR restructures and expands the Discovery/CoreBox documentation into a Diátaxis-style layout (tutorials / how-to / explanation / reference), archives the previous CoreBox docs, and adds new Discovery box content (product-page snapshots, learning-path skeletons, and authoring templates). It also updates redirects and a few navigation links to point at the new/archived locations.
Changes:
- Migrates CoreBox docs to a new Diátaxis structure and moves the prior EN/IT content into
docs/usage/disc/corebox/ARCHIVE/. - Adds new CoreBox tutorial/how-to/explanation/reference pages and supporting sidebar category files.
- Adds Discovery box “product page” markdown snapshots and
learn/templates/skeleton learning paths; updates redirects accordingly.
Reviewed changes
Copilot reviewed 70 out of 133 changed files in this pull request and generated 15 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/usage/README.mdx | Updates CoreBox link to new index page |
| docs/usage/disc/README.mdx | Updates Discovery CoreBox doc link to new index page |
| docs/usage/disc/holobox/tutorials/07_HoloBox_OffAxis_Tomographic_Microscope/scripts/chromatix_offaxis_tomography/01_simulate_hologram.py | Adds hologram simulation script |
| docs/usage/disc/holobox/tutorials/07_HoloBox_OffAxis_Tomographic_Microscope/scripts/chromatix_offaxis_tomography/02_offaxis_reconstruct.py | Adds off-axis reconstruction script |
| docs/usage/disc/holobox/tutorials/07_HoloBox_OffAxis_Tomographic_Microscope/scripts/chromatix_offaxis_tomography/03_inverse_reconstruct.py | Adds inverse reconstruction/optimization script |
| docs/usage/disc/holobox/tutorials/05_DiscoveryPolarization/Readme.md | Adds polarization tutorial landing page |
| docs/usage/disc/holobox/tutorials/05_DiscoveryPolarization/APP_POL_Three_Polarizers/Readme.md | Adds “three polarizers” tutorial page |
| docs/usage/disc/holobox/tutorials/05_DiscoveryPolarization/APP_POL_Stress_Birefringence/Readme.md | Adds stress birefringence tutorial page |
| docs/usage/disc/holobox/tutorials/05_DiscoveryPolarization/APP_POL_Crossed_Polarizers/Readme.md | Adds crossed polarizers tutorial page |
| docs/usage/disc/corebox/index.md | New CoreBox Diátaxis landing page |
| docs/usage/disc/corebox/tutorials/from-lens-to-projector.md | New CoreBox tutorial |
| docs/usage/disc/corebox/tutorials/build-a-telescope.md | New CoreBox tutorial |
| docs/usage/disc/corebox/tutorials/your-first-microscope.md | New CoreBox tutorial |
| docs/usage/disc/corebox/tutorials/category.yml | Adds Tutorials sidebar category |
| docs/usage/disc/corebox/how-to/measure-a-focal-length.md | New CoreBox how-to guide |
| docs/usage/disc/corebox/how-to/open-and-reconfigure-a-cube.md | New CoreBox how-to guide |
| docs/usage/disc/corebox/how-to/build-the-infinity-microscope.md | New CoreBox how-to guide |
| docs/usage/disc/corebox/how-to/build-the-finite-microscope.md | New CoreBox how-to guide |
| docs/usage/disc/corebox/how-to/prepare-your-own-sample.md | New CoreBox how-to guide |
| docs/usage/disc/corebox/how-to/calibrate-magnification.md | New CoreBox how-to guide |
| docs/usage/disc/corebox/how-to/troubleshoot-the-smartphone-microscope.md | New CoreBox how-to guide |
| docs/usage/disc/corebox/how-to/category.yml | Adds How-to sidebar category |
| docs/usage/disc/corebox/explanation/light-rays-and-lenses.md | New CoreBox explanation page |
| docs/usage/disc/corebox/explanation/how-images-form.md | New CoreBox explanation page |
| docs/usage/disc/corebox/explanation/how-telescopes-work.md | New CoreBox explanation page |
| docs/usage/disc/corebox/explanation/how-a-microscope-works.md | New CoreBox explanation page |
| docs/usage/disc/corebox/explanation/category.yml | Adds Explanation sidebar category |
| docs/usage/disc/corebox/reference/parts-and-parameters.md | New CoreBox reference page |
| docs/usage/disc/corebox/reference/glossary.md | New CoreBox reference page |
| docs/usage/disc/corebox/reference/category.yml | Adds Reference sidebar category |
| docs/usage/disc/corebox/for-teachers.md | Adds teacher-focused CoreBox page |
| docs/usage/disc/corebox/README.md | Removes old CoreBox README (superseded) |
| docs/usage/disc/corebox/en/07_Showcase.md | Removes old EN showcase page (moved to archive) |
| docs/usage/disc/corebox/it/07_Showcase.md | Removes old IT showcase page (moved to archive) |
| docs/usage/disc/corebox/ARCHIVE/README.md | Adds archive landing page for old CoreBox docs |
| docs/usage/disc/corebox/ARCHIVE/en/README.md | Adds archived EN index page |
| docs/usage/disc/corebox/ARCHIVE/en/01_core_intro.md | Adjusts archived EN intro paths |
| docs/usage/disc/corebox/ARCHIVE/en/02_core_lens.md | Adjusts archived EN lens page paths |
| docs/usage/disc/corebox/ARCHIVE/en/03_core_telescope.md | Adjusts archived EN telescope page paths |
| docs/usage/disc/corebox/ARCHIVE/en/05_smartphone_microscope.md | Adjusts archived EN smartphone microscope paths |
| docs/usage/disc/corebox/ARCHIVE/en/06_troubleshoot.md | Adjusts archived EN troubleshooting paths |
| docs/usage/disc/corebox/ARCHIVE/en/07_Showcase.md | Adds archived EN showcase page |
| docs/usage/disc/corebox/ARCHIVE/it/category.yml | Adds archive category label for Italian section |
| docs/usage/disc/corebox/ARCHIVE/it/01_core_intro.md | Adjusts archived IT intro paths |
| docs/usage/disc/corebox/ARCHIVE/it/02_core_lens.md | Adjusts archived IT lens page paths |
| docs/usage/disc/corebox/ARCHIVE/it/03_core_telescope.md | Adjusts archived IT telescope page paths |
| docs/usage/disc/corebox/ARCHIVE/it/05_smartphone_microscope.md | Adjusts archived IT smartphone microscope paths |
| docs/usage/disc/corebox/ARCHIVE/it/06_troubleshoot.md | Adjusts archived IT troubleshooting paths |
| docs/usage/disc/corebox/ARCHIVE/it/07_Showcase.md | Adds archived IT showcase page |
| docs/usage/disc/corebox/ARCHIVE/category.yml | Adds archive sidebar category |
| docs/usage/disc/boxes/corebox.md | Adds CoreBox product snapshot markdown |
| docs/usage/disc/boxes/electronics.md | Adds Electronics Add-On product snapshot markdown |
| docs/usage/disc/boxes/infinitybox.md | Adds Infinity Add-On product snapshot markdown |
| docs/usage/disc/boxes/fluoled.md | Adds Fluo LED product snapshot markdown |
| docs/usage/disc/boxes/fluolaser.md | Adds Fluo Laser product snapshot markdown |
| docs/usage/disc/boxes/lightsheet.md | Adds LightSheet Add-On product snapshot markdown |
| docs/usage/disc/boxes/qbox.md | Adds QBox product snapshot markdown |
| docs/usage/disc/boxes/learn/templates/module.md | Adds module authoring template |
| docs/usage/disc/boxes/learn/templates/experiment.md | Adds experiment authoring template |
| docs/usage/disc/boxes/learn/templates/box-concept.md | Adds didactics concept template |
| docs/usage/disc/boxes/learn/lightsheet/index.md | Adds LightSheet learning-path skeleton |
| docs/usage/disc/boxes/learn/infinity/index.md | Adds Infinity learning-path skeleton |
| docs/usage/disc/boxes/learn/i18n/README.md | Adds i18n workflow guidance |
| docs/usage/disc/boxes/learn/hardware/index.md | Adds hardware overview page |
| docs/usage/disc/boxes/learn/hardware/cube-mechanics.md | Adds cube mechanics tutorial/reference |
| docs/usage/disc/boxes/learn/hardware/cube-design-inserts.md | Adds custom insert design how-to |
| docs/usage/disc/boxes/learn/hardware/baseplates.md | Adds baseplates reference |
| docs/usage/disc/boxes/learn/advanced/index.md | Adds advanced setups index |
| docs/usage/disc/boxes/learn/advanced/abbe-setup.md | Adds Abbe limit setup skeleton |
| docs/usage/disc/boxes/learn/advanced/fluo-microscope-full.md | Adds full fluorescence microscope skeleton |
| config/redirects.js | Updates redirects for CoreBox archival migration |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
7
to
9
| from: "/docs/Toolboxes/DiscoveryCore/ENGLISH/coreBOXen", | ||
| to: "/usage/disc/corebox/en/core_intro", | ||
| to: "/usage/disc/corebox/ARCHIVE/en/core_intro", | ||
| }, |
Comment on lines
10
to
+12
| { | ||
| from: "/docs/Toolboxes/DiscoveryCore/ITALIAN/coreBOXit", | ||
| to: "/usage/disc/corebox/it/core_intro", | ||
| to: "/usage/disc/corebox/ARCHIVE/it/core_intro", |
Comment on lines
+19
to
+22
| { | ||
| from: "/usage/disc/corebox/it/", | ||
| to: "/usage/disc/corebox/ARCHIVE/it/core_intro", | ||
| }, |
Comment on lines
+25
to
+27
| "Showcasing Smartphone Microscope Images"].map((id) => ({ | ||
| from: `/usage/disc/corebox/en/${id}`, | ||
| to: `/usage/disc/corebox/ARCHIVE/en/${id}`, |
Comment on lines
+31
to
+34
| "Showcasing Smartphone Microscope ImagesIT"].map((id) => ({ | ||
| from: `/usage/disc/corebox/it/${id}`, | ||
| to: `/usage/disc/corebox/ARCHIVE/it/${id}`, | ||
| })), |
|
|
||
| Upgrade to a professional Fluorescence Imaging System | ||
|
|
||
| The openUC2 Fluoresence Add-On is designed to expand your microscope setup into a fully functional fluorescence microscopy system. This kit includes a fiber-coupled laser, optical components for beam shaping, and a beamsplitter for fluorescence imaging, enabling precise and efficient setups for fluorescence microscopy. |
| Discovery | Light-sheet Add-On | ||
| openUC2 LightSheet Add-On | ||
|
|
||
| Does not work without CoreBox, Electronics Add-On, Infinity Add-On, Fluoresence Add-On Laser Edition and the Rasperry Pi Kit |
|
|
||
| Build Your Fluorescence Microscope Today | ||
|
|
||
| Take the next step in your microscopy journey with the openUC2 Fluoresence Add-On Laser Edition, designed for accessible and efficient fluorescence imaging. |
Comment on lines
+61
to
+62
| Fluoresence Microscopy | ||
| Level up your Infinity-Microscope to create sophisticated fluoresent microscope solutions within minutes. The included 488nm Fibercoubled Laser makes this setup ideal for advanced research. |
Comment on lines
+52
to
+53
| LED powered Fluoresence | ||
| Level up your Infinity-Microscope to create sophisticated fluoresent microscope solutions within minutes. The included 60mA LED makes this setup ideal for every enviroment, without the need for laser-safety regulations. |
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.
No description provided.