docs(mediarequest): add general docs #107
Conversation
✅ Deploy Preview for fossabot-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 WalkthroughWalkthroughAdds comprehensive Media request documentation (index, three guides, category file), updates a voteskip example text for concreteness, and fixes a trailing-newline formatting issue in .gitignore. No functional code changes. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes 🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. 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. 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: 6
🤖 Fix all issues with AI agents
In @docs/mediarequest/02-moderation.md:
- Line 81: The SoundCloud settings bullet has two typos; update the phrase
containing "Trackc" and "uploadd" so it reads "Tracks must have been uploaded by
a given list of [SoundCloud
users](https://help.soundcloud.com/hc/articles/115003567968-Your-Display-Name-Location-and-Profile-URL)
to be requested." Locate the bullet in 02-moderation.md (the Allowed SoundCloud
users line) and replace "Trackc" with "Tracks" and "uploadd" with "uploaded".
- Line 30: Fix the typo in the section heading by changing the header text
"Moderation setings" to "Moderation settings" in the markdown file; locate the
heading line (the "## Moderation setings" line) and update the spelling so the
section reads "## Moderation settings".
In @docs/mediarequest/03-backup-playlist.md:
- Line 24: Replace the incorrect two-word phrase "in to" with the single
preposition "into" in the sentence "You may import an existing YouTube playlist
in to your backup playlist." so it reads "You may import an existing YouTube
playlist into your backup playlist."; locate this exact sentence in
docs/mediarequest/03-backup-playlist.md and update it accordingly.
- Line 8: Sentence contains the doubled auxiliary "can will be picked"; replace
that phrase with a single auxiliary—use "will be picked" (or "can be picked" if
you mean possibility) so the sentence reads "...songs that will be picked at
random..." (or "...songs that can be picked at random..." depending on intended
meaning).
- Line 16: In the sentence that reads 'While Monstercat is a vendor that
provides great creator friendly music, you must still purchase a Monstercat Gold
license to play it on stream,' hyphenate the compound adjective by changing
"creator friendly music" to "creator-friendly music"; also scan the same
document for any other occurrences of the phrase and apply the same hyphenation
where it modifies a noun.
In @docs/mediarequest/index.md:
- Line 21: Update the "See also" link text to match the voteskip command: change
the displayed command name from "!song" to "!voteskip" so the list item reads
"[**!voteskip**](../commands/default/voteskip.md) - Allow viewers to vote on
skipping the currently playing media request." This ensures the link label
matches the linked voteskip documentation.
🧹 Nitpick comments (2)
docs/mediarequest/02-moderation.md (2)
26-26: Hyphenate compound adjective.Line 26 should use a hyphen for the compound adjective "three dot menu" → "three-dot menu".
-You may also ban a track from being requested again using the three dot menu to the side of each request. +You may also ban a track from being requested again using the three-dot menu to the side of each request.
48-48: Hyphenate compound adjective.Line 48 should use a hyphen for the compound adjective "system enforced" → "system-enforced".
-* **Max duration of a single request** - The maximum length a single request may be. Has a system enforced limit of 1 day. +* **Max duration of a single request** - The maximum length a single request may be. Has a system-enforced limit of 1 day.
📜 Review details
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (13)
static/img/mediarequest/backup-playlist-example.pngis excluded by!**/*.pngstatic/img/mediarequest/backup-playlist-youtube-import-example.pngis excluded by!**/*.pngstatic/img/mediarequest/ban-track-from-moderation-queue-example.pngis excluded by!**/*.pngstatic/img/mediarequest/banned-tracks-audits-example.pngis excluded by!**/*.pngstatic/img/mediarequest/banned-tracks-example.pngis excluded by!**/*.pngstatic/img/mediarequest/enable-moderation-queue-example.pngis excluded by!**/*.pngstatic/img/mediarequest/moderation-queue-inline-playback.gifis excluded by!**/*.gifstatic/img/mediarequest/pending-moderation-queue-example.pngis excluded by!**/*.pngstatic/img/mediarequest/playback-location-settings-example.pngis excluded by!**/*.pngstatic/img/mediarequest/queue-limits-example.pngis excluded by!**/*.pngstatic/img/mediarequest/soundcloud-settings-example.pngis excluded by!**/*.pngstatic/img/mediarequest/sr-example.pngis excluded by!**/*.pngstatic/img/mediarequest/youtube-settings-example.pngis excluded by!**/*.png
📒 Files selected for processing (7)
.gitignoredocs/commands/default/voteskip.mddocs/mediarequest/01-requesting-songs.mddocs/mediarequest/02-moderation.mddocs/mediarequest/03-backup-playlist.mddocs/mediarequest/_category_.jsondocs/mediarequest/index.md
🧰 Additional context used
🪛 LanguageTool
docs/mediarequest/02-moderation.md
[grammar] ~22-~22: Ensure spelling is correct
Context: ...nd Fossabot will conveniently provide a popout player that will start playing the requ...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~26-~26: Use a hyphen to join words.
Context: ...om being requested again using the three dot menu to the side of each request. !...
(QB_NEW_EN_HYPHEN)
[grammar] ~30-~30: Ensure spelling is correct
Context: ...ation-queue-example.png) ## Moderation setings Fossabot features a wide range of modera...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~48-~48: Use a hyphen to join words.
Context: ...th a single request may be. Has a system enforced limit of 1 day. ### Banned tra...
(QB_NEW_EN_HYPHEN)
[style] ~52-~52: As a shorter alternative for ‘able to’, consider using “can”.
Context: ...limit of 1 day. ### Banned tracks You are able to ban certain tracks from SoundCloud or Y...
(BE_ABLE_TO)
[grammar] ~81-~81: Ensure spelling is correct
Context: ...uested. * Allowed SoundCloud users: Trackc must have been uploadd by a given list ...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~81-~81: Ensure spelling is correct
Context: ...undCloud users:** Trackc must have been uploadd by a given list of [*SoundCloud users...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
docs/mediarequest/03-backup-playlist.md
[grammar] ~16-~16: Use a hyphen to join words.
Context: ... is a vendor that provides great creator friendly music, you must still purchase ...
(QB_NEW_EN_HYPHEN)
docs/mediarequest/index.md
[style] ~21-~21: Using many exclamation marks might seem excessive (in this case: 6 exclamation marks for a text that’s 960 characters long)
Context: ... - Allow viewers to request media. * !song...
(EN_EXCESSIVE_EXCLAMATION)
docs/mediarequest/01-requesting-songs.md
[style] ~27-~27: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ..., but it will play YouTube Live VODs. * Fossabot will not allow requests that cannot be ...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~28-~28: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...embedded into the media request page. * Fossabot will apply [**YouTube's SafeSearch filt...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
🪛 markdownlint-cli2 (0.18.1)
docs/mediarequest/02-moderation.md
40-40: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
40-40: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
46-46: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
46-46: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
47-47: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
47-47: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
48-48: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
48-48: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
66-66: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
66-66: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
67-67: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
67-67: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
67-67: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
67-67: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
68-68: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
68-68: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
68-68: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
68-68: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
69-69: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
69-69: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
69-69: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
69-69: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
70-70: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
70-70: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
70-70: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
70-70: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
80-80: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
80-80: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
81-81: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
81-81: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
81-81: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
81-81: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
82-82: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
82-82: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
82-82: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
82-82: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
83-83: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
83-83: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
83-83: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
83-83: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Cloudflare Pages
🔇 Additional comments (6)
.gitignore (1)
32-33: LGTM!The trailing newline and formatting align with existing .gitignore conventions. No issues here.
docs/commands/default/voteskip.md (2)
18-18: Example outputs are now concrete and clear.The update from placeholder text to realistic examples makes this documentation much more helpful. The vote count (3) and message format are realistic.
24-24: Well-chosen example track.Using "Rick Astley - Never Gonna Give You Up" is a recognizable, culturally resonant example that makes the documentation memorable and easier to understand.
docs/mediarequest/_category_.json (1)
1-3: Category metadata looks good.The label correctly identifies the documentation section. However, note that the full documentation review would benefit from seeing the five new mediarequest pages mentioned in the PR summary.
The PR summary mentions five new documentation pages for Media request, but only the
_category_.jsonfile is visible in this review scope. The following files are referenced in the AI summary but not included:
- docs/mediarequest/index.md
- docs/mediarequest/01-requesting-songs.md
- docs/mediarequest/02-moderation.md
- docs/mediarequest/03-backup-playlist.md
Could you verify that these files are included in the PR and confirm they follow the documentation style conventions used elsewhere in the project?
docs/mediarequest/01-requesting-songs.md (1)
1-35: LGTM!The documentation is clear, well-structured, and comprehensive. Good use of visual aids and concise explanations of restrictions.
docs/mediarequest/03-backup-playlist.md (1)
1-26: Documentation structure and content are well-organized.The page follows standard Docusaurus markdown conventions with clear front matter, descriptive headings, embedded images, and helpful admonitions. The copyright warning is appropriately prominent and informative. Content flows logically from feature description through default options to usage instructions.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
docs/mediarequest/02-moderation.md (4)
22-22: Fix hyphenation in compound adjective.Line 22 should use "pop-out player" instead of "popout player" when used as a compound adjective.
Suggested fix
-To review a request, simply click the thumbnail, and Fossabot will conveniently provide a popout player that will start playing the request. +To review a request, simply click the thumbnail, and Fossabot will conveniently provide a pop-out player that will start playing the request.
26-26: Fix hyphenation in compound adjective.Line 26 should use "three-dot menu" instead of "three dot menu" for proper compound adjective formatting.
Suggested fix
-You may also ban a track from being requested again using the three dot menu to the side of each request. +You may also ban a track from being requested again using the three-dot menu to the side of each request.
48-48: Fix hyphenation in compound modifier.Line 48 should use "system-enforced limit" instead of "system enforced limit" to properly hyphenate the compound modifier.
Suggested fix
-* **Max duration of a single request** - The maximum length a single request may be. Has a system enforced limit of 1 day. +* **Max duration of a single request** - The maximum length a single request may be. Has a system-enforced limit of 1 day.
52-52: Simplify phrasing for conciseness.Line 52 uses "are able to ban" which can be simplified to "can ban" for tighter prose.
Suggested fix
-You are able to ban certain tracks from SoundCloud or YouTube from playing on stream. You can control the list of banned tracks in your Fossabot dashboard, available under your Media request settings. +You can ban certain tracks from SoundCloud or YouTube from playing on stream. You can control the list of banned tracks in your Fossabot dashboard, available under your Media request settings.
📜 Review details
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
docs/mediarequest/02-moderation.mddocs/mediarequest/03-backup-playlist.mddocs/mediarequest/index.md
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2026-01-10T11:08:31.693Z
Learnt from: aidenwallis
Repo: fossadev/fossabot-docs PR: 107
File: docs/mediarequest/03-backup-playlist.md:16-16
Timestamp: 2026-01-10T11:08:31.693Z
Learning: In the fossabot-docs repository, ensure the phrase 'creator friendly' is used without a hyphen when it functions as a compound adjective modifying a noun. Audit all markdown files under docs/mediarequest for this pattern and update instances to maintain consistent style.
Applied to files:
docs/mediarequest/02-moderation.mddocs/mediarequest/03-backup-playlist.mddocs/mediarequest/index.md
🪛 LanguageTool
docs/mediarequest/02-moderation.md
[grammar] ~22-~22: Ensure spelling is correct
Context: ...nd Fossabot will conveniently provide a popout player that will start playing the requ...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~26-~26: Use a hyphen to join words.
Context: ...om being requested again using the three dot menu to the side of each request. !...
(QB_NEW_EN_HYPHEN)
[grammar] ~48-~48: Use a hyphen to join words.
Context: ...th a single request may be. Has a system enforced limit of 1 day. ### Banned tra...
(QB_NEW_EN_HYPHEN)
[style] ~52-~52: As a shorter alternative for ‘able to’, consider using “can”.
Context: ...limit of 1 day. ### Banned tracks You are able to ban certain tracks from SoundCloud or Y...
(BE_ABLE_TO)
docs/mediarequest/03-backup-playlist.md
[grammar] ~16-~16: Use a hyphen to join words.
Context: ... is a vendor that provides great creator friendly music, you must still purchase ...
(QB_NEW_EN_HYPHEN)
docs/mediarequest/index.md
[style] ~21-~21: Using many exclamation marks might seem excessive (in this case: 6 exclamation marks for a text that’s 964 characters long)
Context: ... - Allow viewers to request media. * [!voteskip](../commands/default/voteskip...
(EN_EXCESSIVE_EXCLAMATION)
🪛 markdownlint-cli2 (0.18.1)
docs/mediarequest/02-moderation.md
40-40: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
40-40: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
46-46: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
46-46: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
47-47: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
47-47: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
48-48: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
48-48: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
66-66: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
66-66: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
67-67: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
67-67: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
67-67: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
67-67: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
68-68: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
68-68: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
68-68: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
68-68: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
69-69: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
69-69: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
69-69: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
69-69: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
70-70: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
70-70: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
70-70: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
70-70: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
80-80: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
80-80: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
81-81: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
81-81: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
81-81: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
81-81: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
82-82: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
82-82: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
82-82: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
82-82: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
83-83: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
83-83: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
83-83: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
83-83: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Cloudflare Pages
🔇 Additional comments (3)
docs/mediarequest/index.md (1)
1-21: Clear overview with good navigation.Well-structured index page that introduces the media request feature and provides convenient links to related commands. The content is concise and scannable.
docs/mediarequest/03-backup-playlist.md (2)
1-26: Backup playlist documentation is clear and well-written.The page effectively explains the backup playlist feature, copyright considerations, and import functionality. Content is accurate and properly formatted.
14-20: Style note: "creator friendly" formatting is correct.The phrase "creator friendly music" on line 16 correctly uses no hyphen when functioning as a compound adjective modifying the noun "music," consistent with fossabot-docs conventions. (Note: Static analysis tools may flag this differently, but the documented style for this repository omits the hyphen in this context.)
|
@coderabbitai can you fix your nitpicks? is that something you can do? |
|
Tip For best results, initiate chat on the files or code changes. 🧩 Analysis chain@aidenwallis: Yes, I can fix the nitpicks I raised! Let me first gather my review comments to see what needs to be addressed. 🏁 Script executed: Length of output: 0 🏁 Script executed: Length of output: 14665 @aidenwallis: Absolutely! I found the remaining nitpicks from my review. Let me read the current files and fix them for you. 🏁 Script executed: Length of output: 1828 @aidenwallis: Great news! It looks like all the remaining nitpicks have already been fixed! 🎉 Here's what I found:
All the issues have been addressed, so no additional changes are needed! |
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.