Knowledge Base Contribution Guide
Tags: meta contributing guide
This document outlines the structure and conventions for adding and organizing content in the Claude Code knowledge base. Following these guidelines ensures our knowledge graph remains easy to navigate, search, and maintain.
Getting Started: Adding New Content
- Choose a Template: Start with a template from the
Templatesdirectory. For example, useWorkshop-Template.mdfor a new workshop orMOC-Template.mdfor a new Map of Content. - Follow Naming Conventions: Name your file using the pattern
YYYY-MM-DD-Topic-Description.mdfor notes, or a descriptive kebab-case name (e.g.,new-feature-guide.md) for evergreen docs. - Use the Tagging System: Add relevant tags from our Tag Index to the frontmatter to ensure your content is discoverable.
- Link Your Content: Integrate your work into the knowledge graph by linking to and from existing documents. If relevant, add your new page to a Map of Content (MOC).
Our Conventions
1. Project Structure
✅ Shallow folder structure implemented
- Main folders: Inbox / Projects / archive
- Projects contains all active documentation
- archive contains completed workshop materials
- Inbox ready for new content
2. File Naming Standardization
✅ All files renamed to follow consistent pattern
- Pattern:
YYYY-MM-DD-Topic-Description.md - Fixed 23 files with incorrect naming
- Standardized capitalization (Claude-Code, MOC, SDK, API)
- Removed spaces in favor of hyphens
3. MOC (Map of Content) Structure
✅ Comprehensive MOC system in place
- Master MOC serves as central hub
- 5 specialized MOCs for major topics:
- Hooks MOC
- TypeScript SDK MOC
- Subagents MOC
- Workshops MOC
- Tag Index (new)
4. Linking System
✅ All wiki links updated and verified
- Fixed broken links from file renames
- Removed redundant path prefixes
- Standardized link format
- Cross-references between related topics
5. Tagging System
✅ Consistent tagging taxonomy
- Feature tags: hooks, typescript, sdk, subagents
- Level tags: beginner, intermediate, advanced
- Type tags: tutorial, reference, workshop, exercises
- Quality tags: best-practices, security, troubleshooting
6. Organization Benefits
- Easy navigation via MOCs and tag index
- Consistent structure for predictable file locations
- Powerful search using tags and links
- Clear learning paths from beginner to advanced
- Minimal folder depth following Obsidian best practices
Key Organizational Documents
- Master Tag Index: A complete list of all tags used in the knowledge base.
- Main Documentation Index: The primary entry point for all documentation.
- Workshop Materials: All workshop-related content.
Next Steps (Optional)
-
Regular maintenance:
- Weekly MOC review
- Tag consistency checks
- Link validation
-
Content expansion:
- Add new content to Inbox first
- Process and organize weekly
- Update MOCs with new links
-
Advanced features:
- Consider Obsidian plugins for visualization
- Implement automated link checking
- Create templates for new content types
Related Resources
- Knowledge Base Overview - Start here for navigation
- Tag Index - Search by tags
- Workshop Materials - Educational materials