Conversation
There was a problem hiding this comment.
Pull request overview
Adds a new “Getting started” FAQ page to help answer common Aspire questions and makes it discoverable from both the docs sidebar and the homepage.
Changes:
- Add a new
/get-started/faq/documentation page. - Add “FAQ” to the “Get started” section of the docs sidebar.
- Add a homepage LinkCard pointing to the new FAQ.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| src/frontend/src/content/docs/index.mdx | Adds a homepage LinkCard linking to the new FAQ page. |
| src/frontend/src/content/docs/get-started/faq.mdx | Introduces the new FAQ content page under Get started. |
| src/frontend/config/sidebar/docs.topics.ts | Adds the FAQ entry to the Get started sidebar group. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| icon="open-book" | ||
| href="/get-started/faq/" | ||
| title="FAQ" | ||
| description="Find answers to frequently asked questions" |
There was a problem hiding this comment.
The new LinkCard description is missing terminal punctuation, which is inconsistent with the other cards in this grid (they end with a period). Consider adding a trailing period for consistency.
| description="Find answers to frequently asked questions" | |
| description="Find answers to frequently asked questions." |
| This page answers common questions about what Aspire is, how it fits into your workflow, what it can do for you, and how it compares to other technologies. | ||
|
|
||
| ### What is Aspire? | ||
|
|
||
| Aspire is an agent-ready, code-first tool to compose, debug, and deploy any distributed app. It makes it easier to build, run, debug, and deploy services across any language, stack, or cloud. It's free and open source at [github.com/microsoft/aspire](https://github.com/microsoft/aspire). | ||
|
|
||
| Its central idea is the **AppHost**: the place where you declare your services, resources, dependencies, endpoints, parameters, and relationships in code instead of scattering that information across many config files. AppHosts can be written in **C# or TypeScript**, which makes Aspire a strong fit for polyglot teams. |
There was a problem hiding this comment.
This FAQ starts immediately with level-3 headings (###) after the page title, which skips the H2 level in the document outline. For accessibility/screen readers and a cleaner TOC structure, promote the questions to ## headings or add a ## FAQ section header and keep questions as ###.
Summary
Fixes #690