Combined AI knowledge base with strict documentation standards

[blink-so]

Summary

This PR combines the best elements from both previous approaches (#2 and #3) while maintaining strict adherence to documentation standards. The critical requirement of never using emojis in headings or list items is emphasized throughout.

Key Changes

Combined Approach

• AI-optimized knowledge base that provides instant Coder expertise
• Interactive Q&A functionality for user support and documentation gaps
• Strict documentation standards to ensure consistency
• Complementary relationship with official docs at https://coder.com/docs

Critical Documentation Standards

• No emojis in headings or list items - This is non-negotiable
• Enhanced style guide with critical rules section
• AI-specific guidelines to prevent common pitfalls
• Quality checklist for all contributions
• Consistent terminology and formatting rules

Repository Structure

shared-docs-kb/
├── Documentation Standards
│   ├── style-guide.md - Enhanced with critical rules
│   ├── templates/ - Content structure scaffolds
│   └── documentation-standards/ - Additional standards
├── Architecture and Mental Models
│   ├── architecture-notes.md - Technical understanding
│   └── repo-navigation.md - Repository ecosystem guide
├── AI Integration and Workflows
│   ├── integration/ - AI-specific configurations
│   └── ai-project-notes.md - Session tracking
└── Reference and Support
    ├── cli-reference.md - Command documentation
    ├── common-questions.md - FAQ and gap tracking
    └── documentation-gaps.md - Missing information tracking

Core Principles

1. Complement, Don't Duplicate

• Official docs at https://coder.com/docs remain the single source of truth
• This knowledge base provides AI-optimized context and patterns
• Contributions go to both official docs (primary) and this KB (auxiliary)

2. Documentation Standards First

• Consistency in style, tone, and formatting is critical
• Never use emojis in headings or list items
• AI should follow established conventions strictly
• All contributions must meet quality standards

3. Shared Resource

• Multiple teams can use this for different purposes
• Contributions welcome from all Coder community members
• Maintains broad utility while staying focused

Use Cases

Documentation Writing

1. Upload style-guide.md for formatting consistency
2. Upload architecture-notes.md for technical context
3. Upload relevant templates for structure guidance
4. AI produces consistent, accurate documentation

User Support (Slack @blink interactions)

1. Upload common-questions.md for known issues and solutions
2. Upload cli-reference.md for command syntax
3. Upload architecture-notes.md for system understanding
4. AI provides knowledgeable, consistent help

Code Review

1. Upload architecture-notes.md for design context
2. Upload style-guide.md for consistency checks
3. AI reviews code against established patterns

Documentation Standards Highlights

Critical Rules

• No emojis in headings: # Getting Started not # 🚀 Getting Started
• No emojis in list items: - Install Coder not - 🔧 Install Coder
• Consistent terminology: workspace, template, agent, provisioner
• Code block languages: Always specify bash, hcl, json, etc.
• Relative links: Use ../admin/configure.md for internal links

AI Guidelines

• Always reference the style guide before writing
• Follow formatting rules strictly for consistency
• Use established terminology from the guide
• Include working examples that have been tested
• Check against the quality checklist before submitting

Session Documentation

This approach is documented in ai-project-notes.md as Session ID: 2025-01-15-004, showing how the two previous approaches were combined while maintaining the critical documentation standards.

Benefits

• Instant AI expertise without formal training on Coder codebase
• Consistent documentation through strict style standards
• Interactive Q&A capability for user support
• Gap detection and contribution to official documentation
• Scalable foundation for team-specific knowledge bases
• Quality assurance through systematic standards

This PR supersedes the previous two PRs and provides a single, coherent approach that delivers on the original vision while maintaining the highest documentation standards.