Skip to content

docs(training): combine into one section and more#1554

Merged
jdegand merged 2 commits intoPatrickJS:gh-pagesfrom
jdegand:various-18
Jul 30, 2025
Merged

docs(training): combine into one section and more#1554
jdegand merged 2 commits intoPatrickJS:gh-pagesfrom
jdegand:various-18

Conversation

@jdegand
Copy link
Copy Markdown
Collaborator

@jdegand jdegand commented Jul 30, 2025

Summary by CodeRabbit

  • Documentation
    • Updated the badge image in the README.
    • Consolidated "Online Training" and "On-Site Training" sections into a single "Training" section with reorganized and updated resources.
    • Removed one community link from the Community section.
    • Made minor textual adjustments to training resource descriptions.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Jul 30, 2025

Walkthrough

The README.md file was updated to consolidate the "Online Training" and "On-Site Training" sections into a single "Training" section, reorganize and update the listed training resources, replace the "Awesome" badge image URL, and remove one community link. Minor textual adjustments were also made.

Changes

Cohort / File(s) Change Summary
README Updates
README.md
Consolidated training sections, reorganized and updated training resources, replaced badge image URL, removed a community link, and made minor textual adjustments.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

Poem

🐇
With badges anew and sections combined,
Training resources now perfectly aligned.
A hop through the README, links tidy and neat,
Community trimmed, the update’s complete!
In the garden of docs, this bunny’s delight—
Everything’s clearer, and all feels right.
🥕✨

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between df7368b and f697b1a.

📒 Files selected for processing (1)
  • README.md (3 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • README.md
✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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 generate unit tests to generate unit tests for 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
Copy Markdown
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: 0

🧹 Nitpick comments (1)
README.md (1)

357-370: Bullet formatting & grammar inconsistencies in the new Training list

Several bullets were split across two physical lines, which renders fine in GitHub but makes future edits error-prone and leaves odd phrasing (“The Angular Coach” newline “You Need.”).

Suggested tidy-up:

-* [Angular Training](https://www.angulartraining.com/) - The Angular Coach
-You Need.
+* [Angular Training](https://www.angulartraining.com/) – The Angular Coach **you need**.
...
-* [Ultimate Courses](https://ultimatecourses.com/courses/angular) - Everything you need to
-become an Angular expert.
+* [Ultimate Courses](https://ultimatecourses.com/courses/angular) – Everything you need to become an Angular expert.

Benefits:

  • Keeps each list item self-contained (simpler diffs later).
  • Fixes the mid-sentence line-break and capitalization.
  • Harmonises dash style (“–”) with the rest of the doc.

Apply similar one-liner consolidation to any remaining two-line bullets in this section for consistency.

Also applies to: 371-377

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 89b02ae and df7368b.

📒 Files selected for processing (1)
  • README.md (3 hunks)
🔇 Additional comments (1)
README.md (1)

35-37: Anchor label mismatch risk – verify TOC link

* [Training](#training) introduces a new anchor that replaces the previous “Online / On-Site Training” entries.
Confirm that the corresponding heading is exactly ##### Training, otherwise the link will break on GitHub‐rendered Markdown.
No action required if the slug matches, but worth a quick eyeball scan before you merge.

@jdegand jdegand merged commit 3a640d3 into PatrickJS:gh-pages Jul 30, 2025
1 check passed
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