Update experiments.md

[Aveyron-RetD]

Add the mention of # to add experiments or resources

:)

Summary by CodeRabbit

• Documentation
  • Rewrote Linked Resources/Experiments guidance to a Main-text-first workflow: insert links by typing '#' in the main text, wait for autocomplete (after ~3 characters), select an entry and press Enter to add it both as a hyperlink in the text and to the Linked list.
  • Clarified how to add links directly in the Linked Resources/Experiments section using its autocomplete and selection flow.
  • Retained and repositioned the explanation for viewing linked items.

[coderabbitai]

Warning

Rate limit exceeded

@Aveyron-RetD has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 12 minutes and 37 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 0d77d6fb-8c3c-4678-accc-0e67cb54ac4d

📥 Commits

Reviewing files that changed from the base of the PR and between 108d578 and 0b0be33.

📒 Files selected for processing (1)

• docs/usage/user-guide/experiments.md

Walkthrough

The Linked Resources/Experiments documentation was rewritten to specify a Main-text-first linking flow: type # in the main text, wait for autocomplete after three characters, select an entry and press Enter to insert the hyperlink and add it to the linked list. Direct addition in the Linked Experiments section was clarified.

Changes

Cohort / File(s)	Summary
Documentation Update docs/usage/user-guide/experiments.md	Rewrote "Linked Resources/Experiments" instructions to require typing # in the main text, using autocomplete after three characters, selecting an entry and pressing Enter to insert links. Clarified steps for adding links directly within the Linked Experiments/Resources subsection.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

Make it so: a hash, a pause, a choice,
Three letters call the list, we hear its voice,
Select and press — the link appears anew,
Experiments and resources, tidy and true,
Documentation set to course, steady and blue.

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title "Update experiments.md" is vague and generic, failing to convey the specific nature of the changes made to the documentation.	Consider revising the title to be more descriptive, such as "Document # syntax for adding experiments or resources in experiments.md" to clearly communicate the main change.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (1)

docs/usage/user-guide/experiments.md (1)

502-502: The workflow documentation is solid, but could be refined.

Consider these optional improvements to enhance clarity:

1. Format the # symbol with backticks for visual distinction
2. Capitalize "Enter" to match keyboard key convention
3. The phrase "as well as in the text editor with a hyperlink to the linked entry" could be streamlined

These adjustments would make the documentation more polished, though the current version is functional.

✨ Proposed refinements

-In the Main text type # and begin to type the title of the entry you want to link. After three characters, an autocompletion list will appear. Select the entry you want to link and press enter. This entry will automatically be added to the Linked Experiments/Resources section as well as in the text editor with a hyperlink to the linked entry.
+In the Main text, type `#` and begin typing the title of the entry you want to link. After three characters, an autocompletion list will appear. Select the entry you want to link and press Enter. This entry will automatically be added to the Linked Experiments/Resources section and inserted as a hyperlink in the text editor.

🤖 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 502, Update the sentence that
begins "In the Main text type # and begin to type the title..." by formatting
the hash symbol as `#`, capitalizing the keyboard key "Enter", and streamlining
the trailing phrase; replace "and press enter. This entry will automatically be
added to the Linked Experiments/Resources section as well as in the text editor
with a hyperlink to the linked entry." with something concise like "and press
Enter; the entry will be added to Linked Experiments/Resources and inserted into
the editor as a hyperlink." Ensure the edited sentence preserves the original
meaning and punctuation.

🤖 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 504: In the "Linked Experiments/Resources" paragraph in
docs/usage/user-guide/experiments.md replace the phrase "will be automatically
be added" with "will be automatically added" (remove the duplicated "be"), add a
comma after "text editor", change "adequate section" to "appropriate section",
and vary one instance of "you want to link" (e.g., "you wish to link" or "to
link") so the sentence reads smoothly and avoids repetition while preserving the
same meaning.

---

Nitpick comments:
In `@docs/usage/user-guide/experiments.md`:
- Line 502: Update the sentence that begins "In the Main text type # and begin
to type the title..." by formatting the hash symbol as `#`, capitalizing the
keyboard key "Enter", and streamlining the trailing phrase; replace "and press
enter. This entry will automatically be added to the Linked
Experiments/Resources section as well as in the text editor with a hyperlink to
the linked entry." with something concise like "and press Enter; the entry will
be added to Linked Experiments/Resources and inserted into the editor as a
hyperlink." Ensure the edited sentence preserves the original meaning and
punctuation.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 0a427171-ee3d-4f06-b18d-fe600fcd68f5

📥 Commits

Reviewing files that changed from the base of the PR and between 0db8103 and b58165d.

📒 Files selected for processing (1)

• docs/usage/user-guide/experiments.md

[coderabbitai]

Actionable comments posted: 1

🤖 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 502: The sentence on Line 502 should use "press Enter" (capital E) and
remove the redundant phrase "entry you want to link" to tighten the wording;
update the sentence that currently reads "Select the entry you want to link and
press enter. This entry will automatically be added..." to something like
"Select the entry and press Enter; it will automatically be added to the Linked
Experiments/Resources section and inserted into the editor as a hyperlink,"
ensuring the change is applied where that paragraph appears in the
experiments.md content.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: a490b6b9-426e-4b81-8308-f671aa938218

📥 Commits

Reviewing files that changed from the base of the PR and between b58165d and 108d578.

📒 Files selected for processing (1)

• docs/usage/user-guide/experiments.md

[NicolasCARPi]

Thanks!