-
Notifications
You must be signed in to change notification settings - Fork 21
Add "Setup and tooling" section to sidebar with new Dev environment article #90
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: main
Are you sure you want to change the base?
Conversation
Co-authored-by: IEvangelist <[email protected]>
…references Co-authored-by: IEvangelist <[email protected]>
IEvangelist
left a 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.
Hey @copilot, please try to update the headings so that they're outside the , ideally the pivot only changes the rendered content, but not the headings. Also, please see all other feedback.
…components Co-authored-by: IEvangelist <[email protected]>
Done in commit ebcba15. All headings (h2, h3, h4) are now outside of ## Heading
<Pivot id="...">
Content here
</Pivot>This provides better document structure and accessibility. Warning Firewall rules blocked me from connecting to one or more addresses (expand for details)I tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
IEvangelist
left a 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.
Hey @copilot, the headings need to be shared across each pivot. That's what I was trying to explain, generic headings so that when I toggle the pivot - the headings are the same regardless of selection.
Co-authored-by: IEvangelist <[email protected]>
Done in commit 630920c. Restructured the document so headings are now shared across all pivot options: Generic headings (visible for all selections):
When users toggle between VS Code, Visual Studio, Rider, or CLI, the same headings remain visible with environment-specific content underneath each heading. This provides a consistent navigation experience regardless of which development environment is selected. For example, the "## Installation" heading now appears once, and each Pivot contains its own installation instructions specific to that IDE/tool. |
Co-authored-by: IEvangelist <[email protected]>
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 restructures the "Get started" sidebar by introducing a new "Setup and tooling" parent section that contains the "Prerequisites" and a newly created "Dev environment" article. The new article provides comprehensive guidance on different development environments for Aspire, using interactive Pivot components to switch between Visual Studio Code, Visual Studio, JetBrains Rider, and Aspire CLI.
Key Changes
- Added a new "Setup and tooling" parent section in the sidebar hierarchy
- Created a comprehensive "Dev environment" article with IDE-specific guidance using Pivot/PivotSelector components
- Moved "Prerequisites" to be nested under the "Setup and tooling" section
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
src/frontend/src/content/docs/get-started/dev-environment.mdx |
New comprehensive article detailing different development environments (VS Code, Visual Studio, Rider, Aspire CLI) with installation instructions, setup steps, features, and getting started guides for each platform |
src/frontend/sidebar.topics.ts |
Updated sidebar structure to add "Setup and tooling" parent section with nested "Prerequisites" and "Dev environment" items, including translations for all supported languages |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review for a chance to win a $100 gift card. Take the survey.
Co-authored-by: Copilot <[email protected]>
|
I'm curious what you think about this one @mitchdenny. I know it's still missing the codespaces and dev container bits you were initially describing. Would you imagine those would look like we had originally on Learn? |
Implementation Plan
Fixes #64
I will implement the following changes to restructure the "Get started" sidebar section:
Summary
This PR successfully restructures the "Get started" sidebar by adding a new "Setup and tooling" parent section with "Prerequisites" and a new "Dev environment" article nested underneath. The new article uses Pivot/PivotSelector components to provide environment-specific guidance for Visual Studio Code, Visual Studio, JetBrains Rider, and the Aspire CLI.
Changes Made
1. Created
/src/frontend/src/content/docs/get-started/dev-environment.mdx2. Updated
/src/frontend/sidebar.topics.ts3. Addressed PR Review Feedback
tableOfContentsconfiguration from frontmatterCtrl+Shift+XorCmd+Shift+Xon macOS) with<Kbd>components<Steps>components<Kbd windows="F5" />instead of F54. Code Quality
The changes improve the documentation structure and provide a consistent, accessible user experience with proper keyboard shortcut formatting, step-by-step instructions, and a unified heading structure that works across all pivot selections.
Original prompt
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.