documentation

原文涵盖的主题

• Documentation standard
• Table of contents
• General rules for all documents
• Document structure
• Table of contents
• Formatting
• Markdown guidelines
• Code blocks

General rules for all documents Document structure Table of contents Formatting Markdown guidelines Code blocks Emojis Best practices for AI-assisted documentation Visual documentation Related resources and URLs Specific instructions File references See also -- These rules apply to ALL markdown documents in the project. All documents must follow this structure: Requirements: ALL documents MUST have a table of contents — no length threshold Include up to 3 levels (##, ### and ####) whenever they exist — EVERY real heading in the document gets a TOC entry. Headings inside code fences are not headings and stay out Place it AT THE VERY TOP, directly after the # Title — NEVER any chapter, purpose statement or other content before it. An intro/purpose text becomes the FIRST CHAPTER after the TOC, like everything else. The heading must be ## Table of contents (no emoji) Format: Titles and headings: Document title: # Title (only one per document) Main sections: ## Section Subsections: ### Subsection Separators: Use --- between logical sections Always --- after the table of contents -- Always specify the language at the START: tsx for code with JSX (React: ) typescript for TypeScript withou

这里只展示节选，请以完整原文和当前要求为准。