2024-09-25 Documentation Meeting

[glopesdev]

Agenda

• All docs hosted in https://sainsburywellcomecentre.github.io/aeon_docs/
• Documentation use cases
• Software
• Python API
• Analysis (Example notebooks)
  • Python analysis
  • DJ Analysis
• Hardware / Firmware (MWE)
• Ephys
• Experiments

Proposals

• Index documentation by arena modules #24

[lochhh]

Diataxis

[glopesdev]

• Docs Landing page:

  • I want to:
    • Build a new experiment with Aeon components
    • Analyse or understanding experiments that were run on Aeon
  • Browse Aeon functional modules (infrastructure docs)
  • Browse Aeon experiments (experiments docs)

• Minimal viable site for SfN

• Need to define functional modules for index (examples below)

  • Feeder
  • Nest
  • Tracking
  • Ephys
  • ...

[glopesdev]

For reference, additional examples of documentation websites using Bonsai which have been popping up:

• https://allenneuraldynamics.github.io/Bonsai.AllenNeuralDynamics/
• https://open-ephys.github.io/onix1-bonsai-docs/index.html
• https://fchampalimaud.github.io/cf.bonsai/workflows/HarpExamples/BehaviorBoard/AnalogInput/AnalogInput.html