Skip to content

Add documentation#341

Open
EZoni wants to merge 14 commits into
BLAST-AI-ML:mainfrom
EZoni:setup_docs
Open

Add documentation#341
EZoni wants to merge 14 commits into
BLAST-AI-ML:mainfrom
EZoni:setup_docs

Conversation

@EZoni

@EZoni EZoni commented Dec 11, 2025 •
edited
Loading

Copy link
Copy Markdown
Member

Overview

Add first draft documentation for Synapse.

Here's an outlook of the landing page:

Screenshot from 2026-06-22 10-24-57

To do

  • Add minimal working setup.
  • Add first draft, starting from the existing README files.

Test

cd docs
conda env create -f docs.yml
conda activate synapse-docs
make html

Follow up

  • Set up continuous deployment via Read the Docs.

EZoni
EZoni commented Dec 11, 2025
View reviewed changes
Comment thread docs/source/conf.py

project = "Synapse"
copyright = "BSD-3-Clause-LBNL"
author = "Arjun Dhamrait, Andrea Diaz, Marco Garten, Axel Huebl, Revathi Jambunathan, Remi Lehe, Ethan Rodriguez, Olga Shapoval, Jean-Luc Vay, Edoardo Zoni"

@EZoni EZoni Dec 11, 2025

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

To discuss:

  • Names (so far, all contributors plus Jean-Luc Vay).
  • Order (so far, alphabetical with respect to the last name).

@EZoni EZoni mentioned this pull request Jan 30, 2026
Merged
3 tasks
EZoni
EZoni commented Jun 18, 2026
View reviewed changes
Comment thread docs/source/dashboard.md Outdated
EZoni
EZoni commented Jun 18, 2026
View reviewed changes
Comment thread docs/source/data-model.md

Records should include fields for the configured input and output variable names.

Simulation records may use simulation-space names when `simulation_calibration` maps them back to experimental names.

@EZoni EZoni Jun 18, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

@RemiLehe

"May use" or "must use" here?

EZoni
EZoni commented Jun 18, 2026
View reviewed changes
Comment thread docs/source/dashboard.md Outdated
EZoni
EZoni commented Jun 18, 2026
View reviewed changes
Comment thread docs/source/deployment.md Outdated
EZoni
EZoni commented Jun 18, 2026
View reviewed changes
Comment thread docs/source/simulations.md Outdated
EZoni and others added 2 commits June 18, 2026 15:06
@EZoni
Apply batch of suggestions
19b48dc 
Co-authored-by: Edoardo Zoni <59625522+EZoni@users.noreply.github.com>
@EZoni
Apply batch of suggestions
8cc0dbf
@EZoni EZoni changed the title [WIP] Add documentation Add documentation Jun 22, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ax3l ax3l Awaiting requested review from ax3l
@RemiLehe RemiLehe Awaiting requested review from RemiLehe
@RevathiJambunathan RevathiJambunathan Awaiting requested review from RevathiJambunathan

At least 1 approving review is required to merge this pull request.

Assignees

@RemiLehe RemiLehe

Labels

documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@EZoni @RemiLehe