Skip to content

cache.md

Latest commit

 

History

History
200 lines (165 loc) · 5.86 KB

cache.md

File metadata and controls

200 lines (165 loc) · 5.86 KB
Raw

TypeWeaver Documentation Cache

This file tracks the current state of all TypeWeaver ecosystem packages and their documentation needs. This helps Claude understand the project landscape without needing to scan entire applications.

Package Status Overview

CommitWeave ✅ Complete

  • Repository: glincker/commitweave
  • Type: CLI Tool + VS Code Extension
  • Status: Production ready with comprehensive documentation
  • Documentation: Complete (30+ pages)
  • Last Updated: 2025-08-11

Features Documented:

  • ✅ Installation (npm, yarn, pnpm, macOS, Windows, Docker)
  • ✅ CLI Reference (all commands with examples)
  • ✅ Configuration (complete JSON schema)
  • ✅ Configuration Templates (4 templates: team, enterprise, open-source, offline)
  • ✅ VS Code Extension (full integration guide)
  • ✅ Examples (real-world scenarios)
  • ✅ Troubleshooting (common issues and solutions)
  • ✅ Comparisons with other tools
  • ✅ Advanced features and roadmap

Architecture:

commitweave/
├── CLI Core (Node.js + TypeScript)
├── AI Integration (OpenAI, Anthropic, local models)
├── VS Code Extension (TypeScript + VS Code API)
├── Configuration System (JSON-based)
└── Validation Engine (conventional commits)

Glin-Profanity 🚧 Needs Documentation

  • Repository: glincker/glin-profanity
  • Type: Content filtering library
  • Status: Production ready but minimal documentation
  • Documentation: Basic (1 page)
  • Priority: High - expand to match CommitWeave standards

Current State:

  • ✅ Basic overview page exists
  • ❌ No installation guide
  • ❌ No API documentation
  • ❌ No usage examples
  • ❌ No configuration options
  • ❌ No troubleshooting guide

Known Features (needs documentation):

  • Content filtering and moderation
  • Multiple language support
  • Customizable filter levels
  • JavaScript/Node.js library
  • Profanity detection algorithms
  • Word replacement functionality

Documentation Plan:

glin-profanity/
├── (introduction)/
│   ├── index.mdx (Getting Started)
│   ├── what-is-glin-profanity.mdx
│   └── comparisons.mdx
├── (setup)/
│   ├── installation/
│   │   ├── index.mdx (npm/yarn/pnpm)
│   │   ├── browser.mdx
│   │   └── cdn.mdx
│   ├── usage.mdx
│   └── configuration.mdx
├── (api-reference)/
│   ├── api-reference.mdx
│   ├── methods.mdx
│   └── options.mdx
└── (advanced)/
    ├── examples.mdx
    ├── troubleshooting.mdx
    └── roadmap.mdx

JSON2TS 📝 Planned

  • Repository: glincker/json2ts
  • Type: TypeScript type generator
  • Status: Development/Planning phase
  • Documentation: Placeholder only
  • Priority: Medium - wait for development completion

Planned Features:

  • JSON to TypeScript interface conversion
  • CLI tool and web interface
  • VS Code extension integration
  • Advanced type inference
  • Configuration options

Type Formatter 📝 Planned

  • Repository: glincker/type-formatter
  • Type: TypeScript code formatter
  • Status: Planning phase
  • Documentation: Placeholder only
  • Priority: Low - future development

Documentation Strategy

Current Architecture

typeweaver-docs/
├── content/docs/
│   ├── commitweave/          # Complete ✅
│   ├── glin-profanity/       # Minimal 🚧
│   ├── json2ts/              # Placeholder 📝
│   └── type-formatter/       # Placeholder 📝
├── src/components/
│   ├── PostHogProvider.tsx   # Analytics
│   └── [fumadocs components]
└── cache.md                  # This file

Documentation Standards

Page Structure Template:

  1. Introduction Section - Overview, value proposition, quick start
  2. Setup Section - Installation, usage, configuration
  3. Reference Section - API docs, CLI commands, examples
  4. Advanced Section - Troubleshooting, roadmap, integrations

Required Elements:

  • ✅ Interactive code examples with copy buttons
  • ✅ Tabs for multiple package managers (npm/yarn/pnpm)
  • ✅ Callout components for tips and warnings
  • ✅ Cross-linking between related sections
  • ✅ Search-optimized headings and descriptions
  • ✅ Consistent navigation structure

Next Actions

Immediate (High Priority)

  1. Glin-Profanity Documentation Expansion
    • Scan the actual repository to understand features
    • Create comprehensive documentation matching CommitWeave standards
    • Add to main site navigation and proxy routing

Short Term (Medium Priority)

  1. Documentation System Improvements
    • Add documentation templates for new packages
    • Improve cross-package linking and search
    • Add package status indicators

Long Term (Low Priority)

  1. Future Package Integration
    • JSON2TS documentation when ready
    • Type Formatter documentation when ready
    • Additional tools as they're developed

Analytics and Performance

Current Setup

  • ✅ PostHog analytics on both sites
  • ✅ Localhost detection and privacy controls
  • ✅ Browser console opt-out functions
  • ✅ Unified cookie system across proxy

SEO Status

  • ✅ Comprehensive sitemaps (27+ URLs)
  • ✅ GLINR Studio branding integration
  • ✅ Schema.org structured data
  • ✅ Social media meta tags
  • ✅ Search engine optimization

Technical Notes

Proxy Configuration

  • ✅ Main site (typeweaver.com) proxies to docs (typeweaver-docs.vercel.app)
  • ✅ CSS and static assets load correctly
  • ✅ PostHog analytics work across both domains
  • ✅ Internal links use absolute paths to prevent 404s

Build Status

  • ✅ Both sites build successfully
  • ✅ TypeScript strict mode compliance
  • ✅ ESLint passing
  • ✅ Fumadocs integration working
  • ✅ Sitemap generation automated

Last Updated: 2025-08-11 Maintainer: Claude Code Assistant