Skip to content

Add TypeScript AppHost parity guidance to doc-writer skill#614

Open
davidfowl wants to merge 4 commits intomainfrom
update-doc-writer-ts-apphost
Open

Add TypeScript AppHost parity guidance to doc-writer skill#614
davidfowl wants to merge 4 commits intomainfrom
update-doc-writer-ts-apphost

Conversation

@davidfowl
Copy link
Contributor

Summary

Updates the doc-writer skill to ensure documentation is written with both C# and TypeScript AppHost support in mind, eliminating C#-only bias.

What changed

  • New "AppHost Language Parity" section with core principles:
    • Always show both C# and TypeScript variants for AppHost code
    • Use language-neutral prose ("Add a Redis resource" not "Call builder.AddRedis()")
    • Neither language is the default — both are equal peers
    • Verify TypeScript APIs exist before writing samples
  • Documented the standard tab pattern (syncKey="apphost-lang") matching existing site conventions
  • Added conventions table covering method casing, async patterns, file titles, and builder creation differences
  • Prose do/don't guidelines to help writers avoid C#-biased language
  • Fallback guidance for when TypeScript support isn't yet available (skip tabs, add a note)
  • Updated integration doc templates (hosting-only and hosting+client) to include both C# and TypeScript examples

- Add 'AppHost Language Parity' section with core principles for
  treating C# and TypeScript as equal first-class citizens
- Document the standard tab pattern (syncKey=apphost-lang) with
  conventions table for method casing, async patterns, file titles
- Provide prose guidelines to avoid C#-biased language
- Add guidance for when TypeScript is not yet supported
- Update hosting-only and hosting+client integration templates to
  include both C# and TypeScript code examples
- Update code block examples to show both languages

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@davidfowl davidfowl requested a review from IEvangelist as a code owner March 26, 2026 01:12
Copilot AI review requested due to automatic review settings March 26, 2026 01:12
Copy link
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

Updates the doc-writer skill to enforce C# / TypeScript AppHost documentation parity and standardize how dual-language AppHost samples are presented.

Changes:

  • Added an “AppHost Language Parity (C# and TypeScript)” section with principles, tabbing pattern, conventions, and fallback guidance.
  • Updated integration doc templates to include C# + TypeScript AppHost examples using Starlight Tabs (syncKey="apphost-lang").
  • Added/updated sample AppHost snippets and titles to be language-neutral (file name only).

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

davidfowl and others added 3 commits March 25, 2026 22:59
Separate await calls for addProject and withReference to match
the documented 'await each builder call' convention. Previously
the samples chained .withReference() on an unawaited promise.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Updated code block syntax for Markdown in SKILL.md.
@IEvangelist IEvangelist enabled auto-merge (squash) March 26, 2026 20:37
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.

3 participants