Skip to content

Add preview feature toggle guidance to CLI configuration docs#722

Open
Copilot wants to merge 2 commits intomainfrom
copilot/add-preview-features-section
Open

Add preview feature toggle guidance to CLI configuration docs#722
Copilot wants to merge 2 commits intomainfrom
copilot/add-preview-features-section

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 15, 2026

Summary

  • add a new Toggle preview feature experiences section to /reference/cli/configuration/
  • explain how to discover available feature flags with aspire config list --all
  • document project-scoped and global (--global) feature enablement with aspire config set
  • document turning features off and removing overrides with aspire config delete

Validation

  • pnpm lint
  • pnpm build:skip-search
  • pnpm --dir ./src/frontend run test:unit:docs
  • pnpm build:skip-search (rerun after final wording updates)
  • parallel_validation (code review + CodeQL)

Copilot AI and others added 2 commits April 15, 2026 19:44
Agent-Logs-Url: https://github.com/microsoft/aspire.dev/sessions/9a0638bc-aa30-4a55-bccf-d00417f2c3b8

Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>
@IEvangelist IEvangelist marked this pull request as ready for review April 15, 2026 20:52
@IEvangelist IEvangelist requested a review from mitchdenny as a code owner April 15, 2026 20:52
Copilot AI review requested due to automatic review settings April 15, 2026 20:52
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

Adds documentation guidance to help users opt into (and back out of) preview CLI experiences using feature flags in aspire config.

Changes:

  • Introduces a new “Toggle preview feature experiences” section under CLI configuration docs
  • Documents discovering features.* keys via aspire config list --all
  • Documents enabling/disabling/removing feature overrides for project-scoped and --global usage

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copy link
Copy Markdown
Member

@JamesNK JamesNK left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Useful addition — the discovery → enable → global → disable flow is well structured. A few suggestions for a follow-up polish pass:

  1. Wrap the numbered list in <Steps> — the site convention for sequential instructions uses the Starlight <Steps> component (would need adding to the imports).
  2. Content overlap — the new section re-covers aspire config set, --global, and aspire config delete which already appear in the "Working with configuration" bullets below. Consider merging or cross-referencing to avoid near-duplicate guidance on the same page.
  3. Concrete example for :<language> suffix — step 3 mentions language-specific flags but doesn't show one. A real key like features:polyglotSupportEnabled would help users know what to look for.
  4. Heading style — other H2s on this page are descriptive noun phrases (Settings surfaced by…, Working with configuration). Toggle preview feature experiences reads as an imperative; Preview feature flags would match the sibling style.

None of these are blockers — approving as-is.

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.

4 participants