Skip to content

[SUPERSEDED] Refactor as AI-optimized knowledge base with documentation standards #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from

Conversation

blink-so[bot]
Copy link

@blink-so blink-so bot commented Jun 9, 2025

Superseded by PR #4

This PR has been superseded by PR #4: Combined AI knowledge base with strict documentation standards.

The combined approach includes all the valuable elements from this PR while maintaining strict documentation standards and providing a more coherent overall solution.

Please review PR #4 instead of this one.

Transform the repository to focus on providing AI assistants with instant Coder expertise rather than duplicating official documentation.

Key changes:
- New README emphasizing AI-optimized knowledge that complements official docs
- Comprehensive documentation standards with style guide and content patterns
- Mental model of how Coder works for AI understanding
- Specialized AI prompts for documentation writing tasks
- Clear separation: official docs = SSoT, this repo = AI knowledge amplifier

New structure:
- documentation-standards/ - Style guides and patterns for consistency
- mental-models/ - High-level understanding of Coder architecture
- ai-prompts/ - Optimized prompts for specific documentation tasks
- patterns/ - Reusable approaches and solutions (to be added)
- community-knowledge/ - Real-world insights (to be added)

Focus areas:
- Documentation consistency through strict style standards
- AI assistance for writing syntax-consistent markdown
- Mental models that help AI understand Coder's architecture
- Prompts optimized for common documentation tasks

This provides instant expertise to any AI assistant without formal training on the codebase.

Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com>
@blink-so blink-so bot changed the title Refactor as AI-optimized knowledge base with documentation standards [SUPERSEDED] Refactor as AI-optimized knowledge base with documentation standards Jun 9, 2025
@blink-so blink-so bot closed this Jun 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants