add starr documentation
This commit is contained in:
18
.github/instructions/ai-doc-attribution.instructions.md
vendored
Normal file
18
.github/instructions/ai-doc-attribution.instructions.md
vendored
Normal file
@@ -0,0 +1,18 @@
|
||||
---
|
||||
description: "Use when writing or updating documentation (Markdown, README, docs pages, guides). Require explicit top-of-document labeling when a document is fully AI-generated."
|
||||
name: "AI Documentation Attribution"
|
||||
applyTo: "**/*.md"
|
||||
---
|
||||
# AI Documentation Attribution
|
||||
|
||||
- When documentation is fully AI-generated, include an explicit attribution note.
|
||||
- The attribution must be visible in the document body and easy to find by readers.
|
||||
- Acceptable labels include one of:
|
||||
1. "AI-generated documentation"
|
||||
- Place the attribution at the top of the document by default.
|
||||
- If only parts are AI-assisted, attribution is optional unless you want to disclose assistance.
|
||||
- Do not imply fully human authorship for content produced by AI.
|
||||
|
||||
Example attribution lines:
|
||||
|
||||
- `> Note: This document was AI-generated and reviewed by a maintainer.`
|
||||
Reference in New Issue
Block a user