-
-
Notifications
You must be signed in to change notification settings - Fork 253
Add 25 stages of the AI Wiki to platform website (#11564) #11565
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
Conversation
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the Note Other AI code review bot(s) detectedCodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review. WalkthroughThe PR adds a new "What You'll Learn - 25 Comprehensive Stages" section to the Interactive Wiki page with detailed stage descriptions and learning journey instructions. Navigation is updated to support hierarchical menu items via new IsExpanded and ChildItems properties on BitNavItem. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes
Poem
Pre-merge checks and finishing touches✅ Passed checks (4 passed)
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 |
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: 1
🧹 Nitpick comments (2)
src/Websites/Platform/src/Bit.Websites.Platform.Client/Pages/Templates/Templates07InteractiveWiki.razor (2)
32-155: Consider refactoring inline styles and using semantic heading tags.All 25 stage IDs correctly match the navigation fragment identifiers, which is excellent! However, consider these optional improvements:
- Replace inline
style="margin-top: 1rem;"with a CSS class for consistency and maintainability- Use semantic heading tags (
<h4>or<h5>) instead of<strong>tags for stage titles to improve document structure and accessibilityExample refactor for one stage:
-<div id="ef-core" style="margin-top: 1rem;"> - <strong>Stage 1: Entity Framework Core</strong> +<div id="ef-core" class="wiki-stage"> + <h4>Stage 1: Entity Framework Core</h4> <p>Learn about DbContext, entity models, entity type configurations, and migrations (optional). Understand nullable reference types in EF Core relationships and client-side offline database support.</p> </div>Then add to CSS:
.wiki-stage { margin-top: 1rem; } .wiki-stage h4 { font-weight: bold; }
160-171: Consider refactoring inline styles for code block.The instructions section is clear and helpful. As a minor optimization, consider moving the inline styles from the
<code>element to a CSS class.Example refactor:
-<code style="display: block; margin: 1rem 0; padding: 0.75rem; background-color: var(--bit-clr-bg-pri); border-radius: 4px;"> +<code class="wiki-command-block"> Run getting started </code>Then add to CSS:
.wiki-command-block { display: block; margin: 1rem 0; padding: 0.75rem; background-color: var(--bit-clr-bg-pri); border-radius: 4px; }
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Knowledge base: Disabled due to Reviews -> Disable Knowledge Base setting
📒 Files selected for processing (2)
src/Websites/Platform/src/Bit.Websites.Platform.Client/Pages/Templates/Templates07InteractiveWiki.razor(1 hunks)src/Websites/Platform/src/Bit.Websites.Platform.Client/Shared/MainLayout.razor.cs(1 hunks)
⏰ 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). (2)
- GitHub Check: CodeQL analysis (csharp)
- GitHub Check: build and test
🔇 Additional comments (2)
src/Websites/Platform/src/Bit.Websites.Platform.Client/Pages/Templates/Templates07InteractiveWiki.razor (1)
24-26: LGTM!The section header is well-structured and clearly introduces the 25 stages content.
src/Websites/Platform/src/Bit.Websites.Platform.Client/Shared/MainLayout.razor.cs (1)
38-72: BitNavItem class properly supports both IsExpanded and ChildItems properties.Verification confirms:
ChildItemsproperty exists aspublic List<BitNavItem> ChildItems { get; set; } = [];IsExpandedproperty exists aspublic bool IsExpanded { get; set; }The code in MainLayout.razor.cs correctly uses these properties with no issues.
...s/Platform/src/Bit.Websites.Platform.Client/Pages/Templates/Templates07InteractiveWiki.razor
Outdated
Show resolved
Hide resolved
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.
Pull Request Overview
This PR enhances the Interactive Wiki documentation by adding a detailed breakdown of all 25 learning stages and creating a navigable hierarchical structure in the side navigation menu.
- Added comprehensive descriptions for all 25 stages of the interactive learning guide
- Created a nested navigation structure with anchor links to each stage section
- Improved user experience by making the Interactive Wiki menu expandable with direct links to specific topics
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| MainLayout.razor.cs | Transformed the "Interactive Wiki" nav item into an expandable parent with 20 child navigation items linking to specific stage sections |
| Templates07InteractiveWiki.razor | Added a new "What You'll Learn - 25 Comprehensive Stages" section with detailed descriptions and anchor IDs for all 25 stages |
closes #11564
Summary by CodeRabbit