Skip to content

docs: tutorials: update api workshop page#9

Merged
NicolasCARPi merged 2 commits into
masterfrom
mouss/260505-quickupdateontutorials
May 6, 2026
Merged

docs: tutorials: update api workshop page#9
NicolasCARPi merged 2 commits into
masterfrom
mouss/260505-quickupdateontutorials

Conversation

@MoustaphaCamara
Copy link
Copy Markdown
Contributor

@MoustaphaCamara MoustaphaCamara commented May 5, 2026

image image

Summary by CodeRabbit

  • Documentation
    • Reorganized API Workshop tutorial with clearer learning goals and structured introduction
    • Added guidance on running Jupyter notebooks locally and via Google Colab
    • Improved link descriptions and formatting for better readability

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 5, 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: 86be37e8-345a-4da5-9303-f5ba2b003bad

📥 Commits

Reviewing files that changed from the base of the PR and between 4eb1b93 and a5d74a7.

📒 Files selected for processing (1)
  • docs/tutorials/api-workshop.md

Walkthrough

Captain's Log: The API Workshop tutorial documentation undergoes a comprehensive redesign. The introduction now charts a clear course through the learning objectives and execution parameters—both local and cloud-based deployment options for the Jupyter notebooks are now prominently documented. Link descriptions receive enhanced formatting and contextual clarity.

Changes

API Workshop Tutorial Redesign

Layer / File(s) Summary
Documentation Structure
docs/tutorials/api-workshop.md (lines 6–17)
The introductory section is reconstituted to clearly establish learning outcomes: mastery of the eLabFTW REST API via Jupyter notebooks. Execution guidance is provided for both local deployment (JupyterLab) and remote execution (Google Colab), with references to prerequisite repository setup.
Video Section Clarification
docs/tutorials/api-workshop.md (lines 18–23)
The video lead-in is refined to state alignment between the instructional video structure and the notebook organization; the embedded YouTube iframe remains constant.
Links Formatting & Clarity
docs/tutorials/api-workshop.md (lines 24–29)
Link entries are enhanced with descriptive text, HTML <br /> tags, and arrow formatting to provide context and improve navigability. Target URLs remain unchanged—repository, endpoints documentation, Python library repository, and HTML documentation are preserved.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~4 minutes

Possibly related PRs

  • elabftw/documentation#1: Directly related—establishes the initial API Workshop page that this PR enhances with improved structure, clarity, and formatting.

Poem

To boldly rewrite what once was unclear, 🚀
We chart new coordinates for learning's frontier,
Each link now shines like a beacon so bright,
And notebooks stand ready—to Colab's own flight,
The workshop ascends to new heights with delight!

🚥 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 'docs: tutorials: update api workshop page' accurately describes the main change - a documentation update to the API workshop tutorial 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 mouss/260505-quickupdateontutorials

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

@MoustaphaCamara MoustaphaCamara changed the title Mouss/260505 quickupdateontutorials docs: tutorials: update api workshop page May 5, 2026
Copy link
Copy Markdown
Contributor

@NicolasCARPi NicolasCARPi left a comment

Choose a reason for hiding this comment

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

💯

@NicolasCARPi NicolasCARPi merged commit 5afdf2b into master May 6, 2026
2 checks passed
@NicolasCARPi NicolasCARPi deleted the mouss/260505-quickupdateontutorials branch May 6, 2026 12:09
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.

2 participants