Skip to content

tutorial: add synthesis experiment#10

Merged
NicolasCARPi merged 2 commits into
masterfrom
nico/260512-chemtuto
May 12, 2026
Merged

tutorial: add synthesis experiment#10
NicolasCARPi merged 2 commits into
masterfrom
nico/260512-chemtuto

Conversation

@NicolasCARPi
Copy link
Copy Markdown
Contributor

@NicolasCARPi NicolasCARPi commented May 12, 2026

:)

Summary by CodeRabbit

  • Documentation
    • New tutorial: step-by-step guide for creating and managing synthesis experiments. Covers creating experiment categories and templates, instantiating experiments from templates, and using the Chemical Structure Editor to draw, attach, and export reaction structures.

Review Change Stack

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 12, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: e26c7b1f-e527-4292-ac13-3069c5ab1f59

📥 Commits

Reviewing files that changed from the base of the PR and between 8363871 and c636663.

📒 Files selected for processing (1)
  • docs/tutorials/synthesis-experiment.md
✅ Files skipped from review due to trivial changes (1)
  • docs/tutorials/synthesis-experiment.md

Walkthrough

New tutorial docs: front-matter and intro; steps to create a Synthesis category and Basic synthesis template; instructions to instantiate an experiment from that template; and guidance for drawing, saving, attaching, and exporting reactions via the Chemical Structure Editor.

Synthesis Experiment Tutorial Documentation

Layer / File(s) Summary
Front-matter and introduction
docs/tutorials/synthesis-experiment.md
Adds page front-matter and an introductory note describing the tutorial scope for chemistry synthesis experiments.
Category and template creation
docs/tutorials/synthesis-experiment.md
Describes creating a “Synthesis” experiment category and a “Basic synthesis” template, including template category selection and populating main/custom fields.
Instantiate experiment from template
docs/tutorials/synthesis-experiment.md
Shows steps to create an experiment from the template by selecting it and completing required fields.
Chemical Structure Editor usage
docs/tutorials/synthesis-experiment.md
Explains using the Chemical Structure Editor to draw reactions, save/attach RXN files, and export/display PNGs within the experiment.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🖖 A new page charts the chemist's course tonight,
Drawn reactions gleam in tutorial light,
Templates and categories set the flight,
RXN saved, PNG shown — all systems right.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'tutorial: add synthesis experiment' accurately describes the main change: adding a new synthesis experiment tutorial documentation page.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch nico/260512-chemtuto

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/tutorials/synthesis-experiment.md`:
- Line 77: Fix the typo in the user-facing instruction by replacing the phrase
"Frome the Tools menu" with the correct "From the Tools menu" in the tutorial
text (the sentence that reads 'Frome the Tools menu, select the "Chemical
Structure Editor"').
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 083f9fe0-455f-40f4-8419-a6e91ed1ff4e

📥 Commits

Reviewing files that changed from the base of the PR and between 5afdf2b and 8363871.

📒 Files selected for processing (10)
  • docs/tutorials/synthesis-experiment.md
  • static/img/tuto-syn-change-category.webp
  • static/img/tuto-syn-create-category.webp
  • static/img/tuto-syn-create-from-template.webp
  • static/img/tuto-syn-create-tpl.webp
  • static/img/tuto-syn-custom-fields.webp
  • static/img/tuto-syn-editor.webp
  • static/img/tuto-syn-exp-cat-menu.webp
  • static/img/tuto-syn-exp-tpl-menu.webp
  • static/img/tuto-syn-show.webp

Comment thread docs/tutorials/synthesis-experiment.md Outdated
@NicolasCARPi NicolasCARPi merged commit 8b3277f into master May 12, 2026
2 checks passed
@NicolasCARPi NicolasCARPi deleted the nico/260512-chemtuto branch May 12, 2026 11:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

1 participant