Skip to content

Commit 00d4358

Browse files
clarkdCopilot
andauthored
Update .github/copilot-instructions.md
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
1 parent 293e67a commit 00d4358

1 file changed

Lines changed: 1 addition & 1 deletion

File tree

.github/copilot-instructions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ When suggesting changes:
7373

7474
### Documentation - (docs/README.md)
7575
- Should typically start headings from level 1. When embedded in SquaredUp, the headings will be sized appropriately.
76-
- When the docs are embedded in SquaredUp, they are shown under a heading labelled "Need help?". As such, discourage documentation that starts with similar headings, or headings that don't make sense. Avoid headings that repeat the plugin name or use "Overview". A good heading might be something like `# Before you start` or `# Pre-requisites`.
76+
- When the docs are embedded in SquaredUp, they are shown under a heading labelled "Need help?". As such, discourage documentation that starts with similar headings, or headings that don't make sense. Avoid headings that repeat the plugin name or use "Overview". A good heading might be something like `# Before you start` or `# Prerequisites`.
7777
- Encourage the author to include documentation for all UI fields from metadata.json unless otherwise covered by a tooltip or help text.
7878
- Encourage the author to include links to the third-party tool or their documentation when appropriate, e.g. `Browse to [unifi.ui.com](https://unifi.ui.com) > Settings -> API Keys > Create New API Key`
7979
- The language should be neutral and clear, providing guidance on how to setup and use the plugin.

0 commit comments

Comments
 (0)