doc: update: full experiments section#7
Merged
Conversation
User guide Concepts & Experiments pages (up to Linked resources) Update of image with recent app updates, fix some links, add new pictures to some categories
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
WalkthroughAs Number One, I report: the experiments user guide was reorganized and rewritten — toolbar actions, view/edit modes, timestamps, locking, linked-entry/import flows and many UI screenshots were updated (PNG → WEBP). The intro page had a single figure swapped to WEBP. (41 words) Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
docs/usage/user-guide/experiments.md (2)
13-604:⚠️ Potential issue | 🔴 CriticalSeal that breach immediately — one image asset is unaccounted for.
Your patch references 45 image files across the documentation, and one does not exist in the repository:
steps-on-template-locked.webp. This file is called out in the "Steps" section (lines approximately 480–488) where you describe locking steps in templates. Before this review can be brought to completion, you must either locate the missing asset or provide it. All other 44 image references are in proper order.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/usage/user-guide/experiments.md` around lines 13 - 604, The docs reference a missing image asset steps-on-template-locked.webp in the "Steps" section (the <figure> with caption "Steps on a template with lock toggle.") of docs/usage/user-guide/experiments.md; fix it by either adding the missing file to the repository at the /img/ path with the exact filename (check case-sensitivity) or update the <img src="/img/steps-on-template-locked.webp" ...> tag to point to a valid existing image (or remove/replace the figure and caption), then verify the figure and its alt text ("steps on template with lock toggle") render correctly.
141-164:⚠️ Potential issue | 🟡 MinorAye, Captain — indent nested list items under numbered entries 10 and 11.
The bullets in lines 146–151 and 158–163 lack proper indentation and will render as top-level items rather than sub-items of their parent entries. Indent them by two spaces. Also, apply bold formatting to item 11's title for consistency with item 10.
Suggested doc fix
10. **Request action**: Request another user to perform an action on a given entry. <figure> <img src="/img/experiment-request-action.webp" width="370" alt="request an action" /> <figcaption>Request an action modal.</figcaption> </figure> -- Archive -- Lock -- Review -- Sign -- Timestamp -- Unarchive + - Archive + - Lock + - Review + - Sign + - Timestamp + - Unarchive -11. Ellipsis menu +11. **Ellipsis menu** <figure> <img src="/img/experiment-ellipsis.webp" alt="ellipsis menu options" /> <figcaption>Ellipsis menu on the side.</figcaption> </figure> -- Transfer ownership: For entries you created, you can transfer ownership to a different user -- See revisions: View revisions to the main text of the entry -- See changelog: View the changelog for the entry -- Hide main text: You can hide the main text section of the entry -- Archive/Unarchive: Archiving removes the entry from the default list and adds it to the list of archived entries -- Delete entry: Perform a soft-delete of the entry + - Transfer ownership: For entries you created, you can transfer ownership to a different user + - See revisions: View revisions to the main text of the entry + - See changelog: View the changelog for the entry + - Hide main text: You can hide the main text section of the entry + - Archive/Unarchive: Archiving removes the entry from the default list and adds it to the list of archived entries + - Delete entry: Perform a soft-delete of the entry🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/usage/user-guide/experiments.md` around lines 141 - 164, Indent the bullet lists that belong to numbered entries 10 and 11 so they become nested sub-items (add two spaces before each bullet under the "Request action" list: "Archive", "Lock", "Review", "Sign", "Timestamp", "Unarchive"; and before each bullet under the ellipsis menu list: "Transfer ownership", "See revisions", "See changelog", "Hide main text", "Archive/Unarchive", "Delete entry"), and make the title for item 11 bold to match item 10’s styling.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/usage/user-guide/experiments.md`:
- Line 515: Replace the phrase "Ethereum based blockchain" with the correct
compound adjective form "Ethereum-based blockchain" in the sentence "we add it
to the Ethereum based blockchain" so the document reads "we add it to the
Ethereum-based blockchain" (update the exact string occurrence in
docs/usage/user-guide/experiments.md).
- Line 64: The sentence "This is the view mode of an experiment with filled
informations." contains incorrect phrasing; update the view-mode intro text to
use correct English such as "This is the view mode of an experiment with
filled-in information." or "This is the view mode of an experiment showing
populated information." Replace the phrase "filled informations" wherever it
appears in the view-mode description to one of these corrected alternatives.
- Around line 518-526: The "Export button" subsection is misplaced inside the
"Blockchain timestamping" section and duplicates earlier toolbar/export
guidance; remove or relocate the Export menu content (the "Export button"
paragraph and figure) out of the "Blockchain timestamping" section and place it
under the existing toolbar/export guidance (the earlier "Export" or "Toolbar"
section referenced around the previous export instructions), ensuring the
"Blockchain timestamping" header only contains timestamp-specific content and
that the export figure/caption appears once in the toolbar/export section.
---
Outside diff comments:
In `@docs/usage/user-guide/experiments.md`:
- Around line 13-604: The docs reference a missing image asset
steps-on-template-locked.webp in the "Steps" section (the <figure> with caption
"Steps on a template with lock toggle.") of
docs/usage/user-guide/experiments.md; fix it by either adding the missing file
to the repository at the /img/ path with the exact filename (check
case-sensitivity) or update the <img src="/img/steps-on-template-locked.webp"
...> tag to point to a valid existing image (or remove/replace the figure and
caption), then verify the figure and its alt text ("steps on template with lock
toggle") render correctly.
- Around line 141-164: Indent the bullet lists that belong to numbered entries
10 and 11 so they become nested sub-items (add two spaces before each bullet
under the "Request action" list: "Archive", "Lock", "Review", "Sign",
"Timestamp", "Unarchive"; and before each bullet under the ellipsis menu list:
"Transfer ownership", "See revisions", "See changelog", "Hide main text",
"Archive/Unarchive", "Delete entry"), and make the title for item 11 bold to
match item 10’s styling.
🪄 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: 848ff188-0a9d-4358-b4cb-6ee4ee680320
⛔ Files ignored due to path filters (16)
static/img/archived-experiment-more-options.pngis excluded by!**/*.pngstatic/img/archived-experiments-multiselect.pngis excluded by!**/*.pngstatic/img/deleted-experiment-multiselect.pngis excluded by!**/*.pngstatic/img/deleted-experiment-restore-entry.pngis excluded by!**/*.pngstatic/img/experiment-link.gifis excluded by!**/*.gifstatic/img/experiments-archive.pngis excluded by!**/*.pngstatic/img/show-archived-uploads.pngis excluded by!**/*.pngstatic/img/steps-on-template.pngis excluded by!**/*.pngstatic/img/user-create-experiment.pngis excluded by!**/*.pngstatic/img/user-experiments-menu-opened.pngis excluded by!**/*.pngstatic/img/user-experiments-menu.pngis excluded by!**/*.pngstatic/img/user-file-uploader.pngis excluded by!**/*.pngstatic/img/user-linked-entries-tools.pngis excluded by!**/*.pngstatic/img/user-scope-button.pngis excluded by!**/*.pngstatic/img/user-show-mode.pngis excluded by!**/*.pngstatic/img/user-switch-layout.pngis excluded by!**/*.png
📒 Files selected for processing (37)
docs/usage/user-guide/experiments.mddocs/usage/user-guide/intro.mdstatic/img/archived-experiment-more-options.webpstatic/img/archived-experiments-multiselect.webpstatic/img/deleted-experiment-multiselect.webpstatic/img/deleted-experiment-restore-entry.webpstatic/img/experiment-duplicate-modal.webpstatic/img/experiment-edit.webpstatic/img/experiment-elabid.webpstatic/img/experiment-ellipsis.webpstatic/img/experiment-insert-image.webpstatic/img/experiment-locked.webpstatic/img/experiment-pinned.webpstatic/img/experiment-request-action.webpstatic/img/experiment-tags.webpstatic/img/experiment-tinymce-add-image.webpstatic/img/experiment-view-toolbar.webpstatic/img/experiment-view.webpstatic/img/experiments-archive.webpstatic/img/export-button.webpstatic/img/markdown-editor.webpstatic/img/markdown-switch-editor.webpstatic/img/show-archived-uploads.webpstatic/img/steps-locked-down.webpstatic/img/steps-on-experiment.webpstatic/img/steps-on-template.webpstatic/img/user-create-experiment.webpstatic/img/user-experiments-menu-opened.webpstatic/img/user-experiments-menu.webpstatic/img/user-file-uploader.webpstatic/img/user-linked-entries-actions.webpstatic/img/user-permissions-edit.webpstatic/img/user-permissions-modal.webpstatic/img/user-scope-button.webpstatic/img/user-show-mode.webpstatic/img/user-switch-layout.webpstatic/img/user-tinymce.webp
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
docs/usage/user-guide/experiments.md (1)
518-518:⚠️ Potential issue | 🟡 MinorRelocate ELN format paragraph out of Blockchain Timestamping section.
Aye, Captain — Line 518 describes export format (RO-Crate/ELN), not blockchain timestamping behavior. It breaks section cohesion and should be moved to the Export documentation area.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/usage/user-guide/experiments.md` at line 518, The paragraph beginning "The ELN format is a new file format based on RO-Crate specification..." is in the wrong section (currently under "Blockchain Timestamping"); move that paragraph out of the Blockchain Timestamping section and place it into the Export documentation area (e.g., the "Export" or "Export formats" subsection) so it sits with other export/format descriptions, keep the GitHub link unchanged, and remove the duplicate occurrence if present.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/usage/user-guide/experiments.md`:
- Around line 525-526: Replace the duplicate-verb sentence fragment "click on
the 'More options' button on the top-right corner of the toolbar and click
'Archive'" with a tightened instruction such as "open the entry, click the 'More
options' button in the toolbar, then select 'Archive'"; update the sentence in
experiments.md where that exact phrase appears to remove the repeated "click"
and keep the action sequence concise and imperative.
---
Duplicate comments:
In `@docs/usage/user-guide/experiments.md`:
- Line 518: The paragraph beginning "The ELN format is a new file format based
on RO-Crate specification..." is in the wrong section (currently under
"Blockchain Timestamping"); move that paragraph out of the Blockchain
Timestamping section and place it into the Export documentation area (e.g., the
"Export" or "Export formats" subsection) so it sits with other export/format
descriptions, keep the GitHub link unchanged, and remove the duplicate
occurrence if present.
🪄 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: 6831883e-ddf8-4621-a295-fd4df095ccf1
📒 Files selected for processing (1)
docs/usage/user-guide/experiments.md
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
docs/usage/user-guide/experiments.md (1)
384-384: Consider tightening the linked-entry action phrasing, Lieutenant.The sentence "next to the possibility to preview the content… there are two actions" reads somewhat indirectly. While the meaning remains clear, a more direct construction would enhance readability.
Suggested refinement
-In Edit mode, next to the possibility to **preview the content** of a linked entry **(1)** and to **delete a link (4)**, there are two actions to import content from a linked entry: +In Edit mode, in addition to **previewing the content** of a linked entry **(1)** and **deleting a link (4)**, you can import content from a linked entry using two actions:🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/usage/user-guide/experiments.md` at line 384, Replace the indirect sentence "In Edit mode, next to the possibility to preview the content of a linked entry (1) and to delete a link (4), there are two actions to import content from a linked entry:" with a more direct construction that foregrounds the actions; e.g., reword to "In Edit mode you can preview a linked entry (1), delete a link (4), or use two actions to import content from the linked entry:"; update the sentence in docs/usage/user-guide/experiments.md exactly where that paragraph appears so the flow is clearer and concise.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/usage/user-guide/experiments.md`:
- Line 518: Remove the standalone ELN format paragraph that appears inside the
Blockchain Timestamping workflow (the ELN/RO-Crate description after step 4)
because it duplicates content from the "Importing a .eln archive" section of
import-export.md; delete that paragraph so the timestamping flow contains only
blockchain-related steps and leave a single canonical ELN reference in
docs/usage/import-export.md under "Importing a .eln archive".
---
Nitpick comments:
In `@docs/usage/user-guide/experiments.md`:
- Line 384: Replace the indirect sentence "In Edit mode, next to the possibility
to preview the content of a linked entry (1) and to delete a link (4), there are
two actions to import content from a linked entry:" with a more direct
construction that foregrounds the actions; e.g., reword to "In Edit mode you can
preview a linked entry (1), delete a link (4), or use two actions to import
content from the linked entry:"; update the sentence in
docs/usage/user-guide/experiments.md exactly where that paragraph appears so the
flow is clearer and concise.
🪄 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: 249d9603-d182-4676-8cf8-2f67d060942d
📒 Files selected for processing (1)
docs/usage/user-guide/experiments.md
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
docs/usage/user-guide/experiments.md (2)
386-386: Number One suggests refining this phrasing for clarity.Line 386 uses the construction "next to the possibility to" which reads awkwardly. Consider rephrasing for more direct technical writing.
Suggested doc refinement
-In Edit mode, next to the possibility to **preview the content** of a linked entry **(1)** and to **delete a link (4)**, there are two actions to import content from a linked entry: +In Edit mode, in addition to **previewing the content** of a linked entry **(1)** and **deleting a link (4)**, there are two actions to import content from a linked entry:🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/usage/user-guide/experiments.md` at line 386, The phrase "next to the possibility to" is awkward; update the sentence in experiments.md (the line describing Edit mode) to a clearer phrasing such as: "In Edit mode, in addition to previewing the content of a linked entry (1) and deleting a link (4), there are two actions to import content from a linked entry:" — replace the original sentence so it directly uses "in addition to previewing" and "deleting a link" for concise, technical wording.
39-39: Convert image to WebP for consistency with surrounding documentation updates.The file
user-alt-layout.pngat line 39 remains in PNG format while adjacent images in this section—user-switch-layout.webp,user-experiments-menu.webp,user-create-experiment.webp, anduser-file-uploader.webp—have been converted to WebP. The WebP version of this image does not currently exist in the repository. Consider convertingstatic/img/user-alt-layout.pngto WebP format to maintain consistency with the recent image format modernization efforts in this documentation.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/usage/user-guide/experiments.md` at line 39, The image tag references user-alt-layout.png while all adjacent images were converted to WebP; convert the image file user-alt-layout.png to a WebP named user-alt-layout.webp (optimize/encode appropriately), add the new .webp into the images directory, and update the <img src="/img/user-alt-layout.png" ...> reference in experiments.md to point to /img/user-alt-layout.webp (keeping the same alt text and attributes).
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/usage/user-guide/experiments.md`:
- Line 91: The sentence "An autosave is triggered 7 seconds after you stopped
typing." mixes past tense with the present-tense instructional style; change it
to present tense so it reads "An autosave is triggered 7 seconds after you stop
typing." to match the rest of the document and maintain consistency in the user
instructions.
---
Nitpick comments:
In `@docs/usage/user-guide/experiments.md`:
- Line 386: The phrase "next to the possibility to" is awkward; update the
sentence in experiments.md (the line describing Edit mode) to a clearer phrasing
such as: "In Edit mode, in addition to previewing the content of a linked entry
(1) and deleting a link (4), there are two actions to import content from a
linked entry:" — replace the original sentence so it directly uses "in addition
to previewing" and "deleting a link" for concise, technical wording.
- Line 39: The image tag references user-alt-layout.png while all adjacent
images were converted to WebP; convert the image file user-alt-layout.png to a
WebP named user-alt-layout.webp (optimize/encode appropriately), add the new
.webp into the images directory, and update the <img
src="/img/user-alt-layout.png" ...> reference in experiments.md to point to
/img/user-alt-layout.webp (keeping the same alt text and attributes).
🪄 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: 8332bc0b-aebd-499e-9410-338e0e7bdf2c
📒 Files selected for processing (1)
docs/usage/user-guide/experiments.md
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/usage/user-guide/experiments.md`:
- Line 386: Replace the awkward sentence describing linked-entry actions with a
tighter, action-focused line: locate the sentence that currently reads "In Edit
mode, next to the possibility to **preview the content** of a linked entry
**(1)** and to **delete a link (4)**, there are two actions to import content
from a linked entry:" and reword it to a concise form such as "In Edit mode, in
addition to previewing a linked entry (1) and deleting a link (4), you can
import content from a linked entry using two actions:" so the flow stays
parallel and clearer for readers.
- Line 442: The sentence "Several TSA are already configured in eLabFTW:" uses
the unpluralized acronym; update that specific sentence to "Several TSAs are
already configured in eLabFTW:" so the acronym is pluralized for correctness and
readability (leave the preceding "A TSA is a trusted timestamping service..."
sentence as-is).
🪄 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: 1a64e41d-3801-4afc-ad9c-db5ee584928a
📒 Files selected for processing (1)
docs/usage/user-guide/experiments.md
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
2 participants
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.
[text](https://link)or(./anchor)timestampbelowCommentssection, it was right below Toolbar and before we show how to see/Edit an experiment.The whole experiments page changed: run
npm run start->http://localhost:3000/docs/usage/user-guide/experimentsHere are some screenshots
Summary by CodeRabbit