Skip to content

Add Copilot instructions for consistent placeholder formatting in documentationΒ #36149

@wadepickett

Description

@wadepickett

Issue description

In the general copilot instructions for this repository (.github/copilot-instructions.md), please add the following rule in an appropriate location to ensure placeholder formatting consistency. This is not a code specific rule.

Rule to add:

  • Use placeholders with braces format: {placeholderName} consistently throughout the document when used in a URI.
  • Use uppercase for the placeholder name.
    - Launch the app and navigate to `https://localhost:<port>/openapi/v1.json` to view the generated OpenAPI document.
    + Launch the app and navigate to `https://localhost:{PORT}/openapi/v1.json` to view the generated OpenAPI document, where the `{port}` placeholder is the port.

Location:
This rule should be included in the copilot instructions at:
https://github.com/dotnet/AspNetCore.Docs/blob/main/.github/copilot-instructions.md

Assigning to @wadepickett.


Associated WorkItem - 491877

Metadata

Metadata

Labels

docs-experienceseQUESTeredIdentifies that an issue has been imported into Quest.

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions