-
Notifications
You must be signed in to change notification settings - Fork 0
adding monthly sessions to support page #80
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: develop
Are you sure you want to change the base?
Conversation
WalkthroughA new "Monthly sessions" section has been added to the support page, detailing two recurring live digital sessions with descriptions, schedules, and join links. The update positions this section above the existing "Need additional help?" area, leaving the support form and contact information unchanged. Changes
Poem
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 2
🧹 Nitpick comments (3)
pages/support.en-US.mdx (3)
5-6
: Enhance readability and linkage for Jitsi referenceConsider converting "Jitsi" into a clickable link (e.g., Jitsi) and clarifying the sentence for improved readability. For example:
-To help you get the most out of our platform, we offer two types of live digital sessions via Jitsi (an open-source video conferencing tool): +To help you get the most out of our platform, we offer two live digital sessions via [Jitsi](https://jitsi.org), an open-source video-conferencing tool:
9-11
: Improve session details formatting
- Include the event timezone (e.g., "1:00 PM PT").
- Use markdown links for the join URLs instead of raw URLs.
- Replace trailing backslashes (
\
) with proper markdown breaks (two spaces or<br/>
).Example:
-**When**: Every 2nd Thursday of the month at 1:00 PM\ -**What to expect**: A guided walkthrough of key features, best practices, and tips for new and existing users.\ -**Join here**: https://meet.jit.si/MonthlyPlatformOnboarding +**When**: Every 2nd Thursday of the month at 1:00 PM PT +**What to expect**: A guided walkthrough of key features, best practices, and tips for new and existing users. +**Join here**: [Join the Onboarding session](https://meet.jit.si/MonthlyPlatformOnboarding)
15-17
: Apply formatting fixes to Q&A detailsMirror the formatting improvements above—add the timezone, use markdown links, and proper line breaks:
-**When**: Every 4th Thursday of the month at 1:00 PM\ -**What to expect**: An open session to ask questions, troubleshoot issues, and get expert advice.\ -**Join here**: https://meet.jit.si/MonthlyPlatformQandA +**When**: Every 4th Thursday of the month at 1:00 PM PT +**What to expect**: An open session to ask questions, troubleshoot issues, and get expert advice. +**Join here**: [Join the Q&A session](https://meet.jit.si/MonthlyPlatformQandA)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
pages/support.en-US.mdx
(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Travis CI - Pull Request
🔇 Additional comments (2)
pages/support.en-US.mdx (2)
3-4
: Well-placed headerThe new "Monthly sessions" section is introduced with an H2 header, which is consistent with the existing structure under the main H1. The placement above "Need additional help?" maintains logical flow.
3-18
: Verify updates for other localesThis change affects the
en-US
support page. If your documentation supports multiple languages (e.g.,es-ES
,fr-FR
), please ensure that the corresponding localized versions of this page are updated with the same "Monthly sessions" content.
#### 2. Platform Q&A | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🛠️ Refactor suggestion
Use consistent heading levels for Q&A
Similar to the first session, change the Q&A heading from H4 to H3:
-#### 2. Platform Q&A
+### 2. Platform Q&A
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
#### 2. Platform Q&A | |
### 2. Platform Q&A |
🤖 Prompt for AI Agents
In pages/support.en-US.mdx around lines 13 to 14, the heading for the Q&A
section is currently an H4 but should be changed to an H3 to maintain consistent
heading levels with the first session. Update the markdown heading syntax by
reducing one '#' symbol so that the Q&A heading uses three '#' characters
instead of four.
#### 1. Platform Onboarding | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🛠️ Refactor suggestion
Use consistent heading levels
The sub-section headings under an H2 ("Monthly sessions") should use H3 (###
) rather than H4 (####
) to maintain semantic hierarchy:
-#### 1. Platform Onboarding
+### 1. Platform Onboarding
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
#### 1. Platform Onboarding | |
### 1. Platform Onboarding |
🤖 Prompt for AI Agents
In pages/support.en-US.mdx around lines 7 to 8, the heading level for the
sub-section "Platform Onboarding" is currently H4 (####) but should be changed
to H3 (###) to maintain consistent semantic hierarchy under the H2 heading
"Monthly sessions". Update the heading markdown from #### to ### to fix this.
Describe the background of your pull request
Adding the monthly onboarding and Q&A session links to the documentation as discussed here: https://github.com/alkem-io/product/issues/1621
Additional context
Add any other context
Governance
By submitting this pull request I confirm that:
https://github.com/alkem-io/Coordination/blob/master/LICENSE.
Summary by CodeRabbit