doc: update: resources section#8
Merged
Merged
Conversation
|
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 First Officer: The Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 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: 2
🧹 Nitpick comments (2)
docs/usage/user-guide/resources.md (2)
54-54: Consider simplifying the phrasing.The phrase "In order to book" could be more concisely written as "To book". While this is a minor stylistic preference, more direct language serves our users better. As per coding guidelines, the static analysis tool flags this as potentially wordy.
✨ Suggested refinement
-In order to book a Resource, it needs to be bookable. They are not by default. +To book a Resource, it needs to be bookable. They are not by default.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/usage/user-guide/resources.md` at line 54, Replace the wordy sentence "In order to book a Resource, it needs to be bookable. They are not by default." with a concise phrasing such as "To book a resource, it must be bookable; resources are not bookable by default." Locate the sentence in docs/usage/user-guide/resources.md (the line containing the quoted phrase) and update capitalization of "Resource" to lowercase "resource" for consistency while keeping the meaning intact.
99-99: Hyphenate the compound adjective, Lieutenant.The phrase "fine tune" should be hyphenated as "fine-tune" when used as a compound verb in this context. As per coding guidelines, the static analysis tool identifies this as a grammar issue.
✨ Proposed correction
-By default, it will match the `Visibility` permission of the entry, but it can be adjusted to fine tune who exactly has access to this Resource for booking it. +By default, it will match the `Visibility` permission of the entry, but it can be adjusted to fine-tune who exactly has access to this Resource for booking it.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/usage/user-guide/resources.md` at line 99, Update the sentence "By default, it will match the `Visibility` permission of the entry, but it can be adjusted to fine tune who exactly has access to this Resource for booking it." by hyphenating the compound verb: change "fine tune" to "fine-tune" so it reads "...can be adjusted to fine-tune who exactly has access..."; locate this change by searching for the exact sentence or the phrase "Visibility permission of the entry" / "fine tune" in the docs and replace accordingly.
🤖 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/resources.md`:
- Line 63: The sentence "Once this parameter has been activated, clicking this
button same will redirect you to the scheduler with the resource selected."
contains a word-order error; change it to "Once this parameter has been
activated, clicking the same button will redirect you to the scheduler with the
resource selected." to fix the grammar and preserve meaning.
- Line 103: Update the anchor in the link on the line containing "Resources can
be archived or deleted just like experiments. The behavior is exactly the same.
See [Archival](./experiments#Archival) section." to use a lowercase anchor
`./experiments#archival` (change `#Archival` to `#archival`) so it matches the
generated markdown anchor for the header `## Archival` and resolves correctly.
---
Nitpick comments:
In `@docs/usage/user-guide/resources.md`:
- Line 54: Replace the wordy sentence "In order to book a Resource, it needs to
be bookable. They are not by default." with a concise phrasing such as "To book
a resource, it must be bookable; resources are not bookable by default." Locate
the sentence in docs/usage/user-guide/resources.md (the line containing the
quoted phrase) and update capitalization of "Resource" to lowercase "resource"
for consistency while keeping the meaning intact.
- Line 99: Update the sentence "By default, it will match the `Visibility`
permission of the entry, but it can be adjusted to fine tune who exactly has
access to this Resource for booking it." by hyphenating the compound verb:
change "fine tune" to "fine-tune" so it reads "...can be adjusted to fine-tune
who exactly has access..."; locate this change by searching for the exact
sentence or the phrase "Visibility permission of the entry" / "fine tune" in the
docs and replace accordingly.
🪄 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: 3b555a8d-9db1-4046-87ec-16caca7b072d
⛔ Files ignored due to path filters (5)
static/img/book-item-button.pngis excluded by!**/*.pngstatic/img/can-book-setting.pngis excluded by!**/*.pngstatic/img/modify-booking-menu.pngis excluded by!**/*.pngstatic/img/modify-booking-modal.pngis excluded by!**/*.pngstatic/img/scheduler-event-actions.gifis excluded by!**/*.gif
📒 Files selected for processing (19)
docs/usage/user-guide/resources.mdstatic/img/book-item-button.webpstatic/img/can-book-setting.webpstatic/img/modify-booking-menu.webpstatic/img/modify-booking-modal.webpstatic/img/resource-activate-booking.webpstatic/img/resources-menu.webpstatic/img/scheduled-bookings.webpstatic/img/scheduler-bind-experiment.webpstatic/img/scheduler-binded.webpstatic/img/scheduler-create-events.webpstatic/img/scheduler-delete-event.webpstatic/img/scheduler-edit-event.webpstatic/img/scheduler-event-view.webpstatic/img/scheduler-event.webpstatic/img/scheduler-filters-category.webpstatic/img/scheduler-filters-owner.webpstatic/img/scheduler-selected-item.webpstatic/img/scheduler.webp
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
docs/usage/user-guide/resources.md (1)
63-63:⚠️ Potential issue | 🟡 MinorCorrect grammar on redirect sentence (Number One approved).
The sentence reads awkwardly: “clicking this same button…”. Please switch to “clicking the same button…” (or a cleaner variant) so it matches the intended instruction flow.
💡 Proposed fix
-Once this parameter has been activated, clicking this same button will redirect you to the scheduler with the resource selected. +Once this parameter has been activated, clicking the same button will redirect you to the scheduler with the resource selected.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/usage/user-guide/resources.md` at line 63, Edit the sentence in docs/usage/user-guide/resources.md that currently reads "Once this parameter has been activated, clicking this same button will redirect you to the scheduler with the resource selected." and replace "clicking this same button" with a cleaner phrase such as "clicking the same button" or "clicking the button again" so the sentence reads naturally (e.g., "Once this parameter has been activated, clicking the button again will redirect you to the scheduler with the resource selected.").
🧹 Nitpick comments (1)
docs/usage/user-guide/resources.md (1)
54-54: Optional: trim a couple wordy phrases.
- Line 54: “In order to…” is slightly verbose; “To…” reads more snappily.
- Line 103: “The behavior is exactly the same…” could be shortened (and LanguageTool already flags it).
Also applies to: 103-103
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/usage/user-guide/resources.md` at line 54, Replace the wordy sentence "In order to book a Resource, it needs to be bookable. They are not by default." with a snappier version like "To book a Resource, it must be bookable; they are not bookable by default." and similarly shorten the sentence at the later occurrence "The behavior is exactly the same…" to a concise form such as "Behavior is the same…" or "This behaves the same for…" so both spots read more direct and less verbose.
🤖 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/resources.md`:
- Line 99: Update the sentence that currently reads "By default, it will match
the `Visibility` permission of the entry, but it can be adjusted to fine tune
who exactly has access to this Resource for booking it." by hyphenating
"fine-tune" (i.e., replace "fine tune" with "fine-tune") so the phrase reads
"...it can be adjusted to fine-tune who exactly has access to this Resource for
booking it."
---
Duplicate comments:
In `@docs/usage/user-guide/resources.md`:
- Line 63: Edit the sentence in docs/usage/user-guide/resources.md that
currently reads "Once this parameter has been activated, clicking this same
button will redirect you to the scheduler with the resource selected." and
replace "clicking this same button" with a cleaner phrase such as "clicking the
same button" or "clicking the button again" so the sentence reads naturally
(e.g., "Once this parameter has been activated, clicking the button again will
redirect you to the scheduler with the resource selected.").
---
Nitpick comments:
In `@docs/usage/user-guide/resources.md`:
- Line 54: Replace the wordy sentence "In order to book a Resource, it needs to
be bookable. They are not by default." with a snappier version like "To book a
Resource, it must be bookable; they are not bookable by default." and similarly
shorten the sentence at the later occurrence "The behavior is exactly the same…"
to a concise form such as "Behavior is the same…" or "This behaves the same
for…" so both spots read more direct and less verbose.
🪄 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: 7cfd574e-ba75-429f-9392-4691da4e2507
📒 Files selected for processing (1)
docs/usage/user-guide/resources.md
There was a problem hiding this comment.
🧹 Nitpick comments (3)
docs/usage/user-guide/resources.md (3)
192-195: Consider rephrasing “lighten the scheduler’s view”.Line [194] says “use the filters to lighten the scheduler's view…”. “Lighten” is understandable, but “simplify”/“reduce clutter” is more natural in UI documentation.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/usage/user-guide/resources.md` around lines 192 - 195, The phrase "use the filters to lighten the scheduler's view" under the "### Browse events" heading is awkward; update the sentence to use clearer UI wording such as "use the filters to simplify the scheduler's view" or "use the filters to reduce clutter in the scheduler's view" by replacing the phrase "lighten the scheduler's view" with one of these alternatives (reference the heading "### Browse events" and the original phrase "lighten the scheduler's view" to locate the text).
90-104: Trim “exactly the same” to keep the tone tight.Line [103] uses “The behavior is exactly the same…”, which is slightly wordy per the style hint. Consider shortening to e.g. “The behavior is the same…” (or similar) while preserving meaning.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/usage/user-guide/resources.md` around lines 90 - 104, Replace the wordy phrase "The behavior is exactly the same." in the "Archiving and deleting resources" section (heading: Archiving and deleting resources) with a tighter alternative such as "The behavior is the same." or "Behavior is the same." to match the style guide; update the sentence following the heading that references "[Archival](./experiments#archival)" accordingly so the meaning and link remain unchanged.
187-191: Tighten the “either …, or …” grammar.Line [190] has “either send to Members of the team, or to a list of users…”. The comma before “or” is unnecessary and reads slightly off. Consider: “either send to Members of the team or to a list of users…”.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/usage/user-guide/resources.md` around lines 187 - 191, Fix the comma splice in the sentence containing “either send to **Members of the team**, or to a list of users who booked this resource in a specific time range” by removing the comma before “or” so it reads “either send to **Members of the team** or to a list of users who booked this resource in a specific time range”; update that exact sentence in the resources.md content where the figcaption “Delete an event.” appears.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@docs/usage/user-guide/resources.md`:
- Around line 192-195: The phrase "use the filters to lighten the scheduler's
view" under the "### Browse events" heading is awkward; update the sentence to
use clearer UI wording such as "use the filters to simplify the scheduler's
view" or "use the filters to reduce clutter in the scheduler's view" by
replacing the phrase "lighten the scheduler's view" with one of these
alternatives (reference the heading "### Browse events" and the original phrase
"lighten the scheduler's view" to locate the text).
- Around line 90-104: Replace the wordy phrase "The behavior is exactly the
same." in the "Archiving and deleting resources" section (heading: Archiving and
deleting resources) with a tighter alternative such as "The behavior is the
same." or "Behavior is the same." to match the style guide; update the sentence
following the heading that references "[Archival](./experiments#archival)"
accordingly so the meaning and link remain unchanged.
- Around line 187-191: Fix the comma splice in the sentence containing “either
send to **Members of the team**, or to a list of users who booked this resource
in a specific time range” by removing the comma before “or” so it reads “either
send to **Members of the team** or to a list of users who booked this resource
in a specific time range”; update that exact sentence in the resources.md
content where the figcaption “Delete an event.” appears.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: e42aa575-bef3-443f-a803-d09ed9ed1a41
📒 Files selected for processing (1)
docs/usage/user-guide/resources.md
There was a problem hiding this comment.
🧹 Nitpick comments (2)
docs/usage/user-guide/resources.md (2)
103-103: Minor stylistic consideration, if you wish to refine.The phrase "the exact same" could be streamlined to simply "the same" or "identical" for more concise documentation.
✍️ More concise alternatives
-Resources can be archived or deleted just like experiments. The behavior is the exact same. See [Archival](./experiments#archival) section. +Resources can be archived or deleted just like experiments. The behavior is the same. See [Archival](./experiments#archival) section.Or alternatively:
-Resources can be archived or deleted just like experiments. The behavior is the exact same. See [Archival](./experiments#archival) section. +Resources can be archived or deleted just like experiments. The behavior is identical. See [Archival](./experiments#archival) section.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/usage/user-guide/resources.md` at line 103, Replace the phrase "the exact same" in the sentence that reads "The behavior is the exact same." with a more concise alternative such as "the same" or "identical" (locate the literal string "the exact same" in the resources.md content) so the sentence reads e.g. "The behavior is the same." for clearer, more concise documentation.
53-53: Optional refinement for brevity, if you're so inclined.The phrase "In order to book" could be simplified to "To book" for more concise phrasing, though the current wording is perfectly acceptable.
✍️ More concise alternative
-In order to book a Resource, it needs to be bookable. They are not by default. +To book a Resource, it needs to be bookable. They are not by default.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/usage/user-guide/resources.md` at line 53, Replace the wording "In order to book" with the more concise "To book" wherever that exact phrase appears (e.g., in the sentence containing "In order to book") in the document; update the sentence to use "To book" and run a quick pass to ensure spacing and punctuation remain correct.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@docs/usage/user-guide/resources.md`:
- Line 103: Replace the phrase "the exact same" in the sentence that reads "The
behavior is the exact same." with a more concise alternative such as "the same"
or "identical" (locate the literal string "the exact same" in the resources.md
content) so the sentence reads e.g. "The behavior is the same." for clearer,
more concise documentation.
- Line 53: Replace the wording "In order to book" with the more concise "To
book" wherever that exact phrase appears (e.g., in the sentence containing "In
order to book") in the document; update the sentence to use "To book" and run a
quick pass to ensure spacing and punctuation remain correct.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 0dbd6dfa-5b35-46fc-ac3c-5220bf5b5e37
📒 Files selected for processing (1)
docs/usage/user-guide/resources.md
Move scheduler doc to its own page Add descriptions and a new picture
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (3)
docs/usage/user-guide/scheduler.md (2)
118-118: Tighten wording: “exact same” → “same.”Commander’s note: Line 118 is clear but slightly wordy.
🛠️ Suggested edit
-Resources can be archived or deleted just like experiments. The behavior is the exact same. See [Archival](./experiments#archival) section. +Resources can be archived or deleted just like experiments. The behavior is the same. See [Archival](./experiments#archival) section.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/usage/user-guide/scheduler.md` at line 118, Change the wording in the sentence starting "Resources can be archived or deleted just like experiments." — replace "the exact same" with "the same" so the sentence reads "The behavior is the same. See [Archival](./experiments#archival) section." This updates the phrasing while keeping the link to the Archival section unchanged.
12-12: Use “search bar” instead of “searchbar.”Commander’s note: Line 12 uses a nonstandard spelling; use “search bar” for cleaner user-facing documentation.
🛠️ Suggested edit
-Select an item by typing its name in the searchbar. +Select an item by typing its name in the search bar.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/usage/user-guide/scheduler.md` at line 12, Replace the nonstandard compound "searchbar" with the two-word phrase "search bar" in the user-facing sentence ("Select an item by typing its name in the searchbar.") so it reads "Select an item by typing its name in the search bar." and ensure any other occurrences of "searchbar" in the same document (e.g., in scheduler.md) are updated consistently.docs/usage/user-guide/resources.md (1)
78-78: Polish casing and phrasing in the booking instruction.Commander’s note: Line 78 has awkward phrasing (“Once all is set”) and mid-sentence capitalization (“Users”).
🛠️ Suggested edit
-Once all is set, Users can click the `Book item` button in the toolbar, or select it from the Scheduler page, and click the calendar to drag a booking slot. +Once everything is set, users can click the `Book item` button in the toolbar, or open the Scheduler page and drag on the calendar to create a booking slot.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/usage/user-guide/resources.md` at line 78, The sentence uses awkward phrasing and incorrect mid-sentence capitalization; replace "Once all is set, Users can click the `Book item` button in the toolbar, or select it from the Scheduler page, and click the calendar to drag a booking slot." with a smoother, lowercased version such as: "Once everything is set up, users can click the `Book item` button in the toolbar or select it from the Scheduler page, then click and drag on the calendar to create a booking slot." Update the text in resources.md accordingly.
🤖 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/resources.md`:
- Line 54: The sentence "In order to book a Resource, it needs to be bookable.
They are not by default." has a singular/plural pronoun mismatch; revise it so
number agrees and reads clearly — e.g., reference the original sentence and
replace it with a single, consistent construction such as making both noun and
pronoun singular ("A Resource must be bookable; it is not by default.") or both
plural ("Resources must be bookable; they are not bookable by default.") so that
"Resource" and its pronoun agree.
- Around line 28-30: The text uses incorrect pluralization/terminology like
"Resources Categories/Templates"; update all occurrences to the correct terms
"Resource Categories" and "Resource Templates" (and use singular "Resource
Category"/"Resource Template" where referring to a single item) so the phrasing
in the paragraph about assigning a template to a category and the examples
("Antibodies", "Primary Antibody", "Secondary Antibody") is consistent and
grammatically correct; ensure the sentence "It's also fine to keep a one-to-one
relationship between Resources Templates and Resources Categories." becomes
"It's also fine to keep a one-to-one relationship between Resource Templates and
Resource Categories." and similar fixes elsewhere in the snippet.
In `@docs/usage/user-guide/scheduler.md`:
- Line 45: The sentence fragment "Below, the date of the event, the time-slot
and duration in minutes." should be rewritten to a complete, readable sentence;
replace it with a clear statement such as "Below are the event date, the time
slot, and the duration in minutes." to fix grammar and flow in the scheduler.md
content.
---
Nitpick comments:
In `@docs/usage/user-guide/resources.md`:
- Line 78: The sentence uses awkward phrasing and incorrect mid-sentence
capitalization; replace "Once all is set, Users can click the `Book item` button
in the toolbar, or select it from the Scheduler page, and click the calendar to
drag a booking slot." with a smoother, lowercased version such as: "Once
everything is set up, users can click the `Book item` button in the toolbar or
select it from the Scheduler page, then click and drag on the calendar to create
a booking slot." Update the text in resources.md accordingly.
In `@docs/usage/user-guide/scheduler.md`:
- Line 118: Change the wording in the sentence starting "Resources can be
archived or deleted just like experiments." — replace "the exact same" with "the
same" so the sentence reads "The behavior is the same. See
[Archival](./experiments#archival) section." This updates the phrasing while
keeping the link to the Archival section unchanged.
- Line 12: Replace the nonstandard compound "searchbar" with the two-word phrase
"search bar" in the user-facing sentence ("Select an item by typing its name in
the searchbar.") so it reads "Select an item by typing its name in the search
bar." and ensure any other occurrences of "searchbar" in the same document
(e.g., in scheduler.md) are updated consistently.
🪄 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: 1f18a909-29bc-483e-ae1a-89d343ce62b2
📒 Files selected for processing (3)
docs/usage/user-guide/resources.mddocs/usage/user-guide/scheduler.mdstatic/img/scheduler-select-item.webp
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.
Rephrase part of the documentation, fix links, replace/add screenshots, document
EventssectionSummary by CodeRabbit