Skip to content

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

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

DonnaDuiker
Copy link
Contributor

@DonnaDuiker DonnaDuiker commented May 28, 2025

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

  • Documentation is added
  • Test cases are added or updated

By submitting this pull request I confirm that:

Summary by CodeRabbit

  • New Features
    • Added a "Monthly sessions" section to the support page, detailing live onboarding and Q&A sessions with direct join links.

Copy link
Contributor

coderabbitai bot commented May 28, 2025

Walkthrough

A 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

File(s) Change Summary
pages/support.en-US.mdx Added "Monthly sessions" section with details and links for two recurring live Jitsi sessions.

Poem

In the warren of support, new sessions appear,
Twice a month, answers and guidance are near.
Hop onto Jitsi, let questions take flight,
Onboarding or Q&A, both shining bright.
Rabbits unite, for help’s just a hop away—
Join us each Thursday, and brighten your day! 🐇✨


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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need 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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a 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 reference

Consider 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 details

Mirror 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

📥 Commits

Reviewing files that changed from the base of the PR and between d6bf2cb and ec6da8a.

📒 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 header

The 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 locales

This 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.

Comment on lines +13 to +14
#### 2. Platform Q&A

Copy link
Contributor

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.

Suggested change
#### 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.

Comment on lines +7 to +8
#### 1. Platform Onboarding

Copy link
Contributor

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.

Suggested change
#### 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.

@DonnaDuiker DonnaDuiker requested a review from SimoneZaza May 28, 2025 14:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant