docs: Add comprehensive knowledge module documentation (closes #80) #118

Merged
jason.woltje merged 6 commits from feature/knowledge-docs into develop 2026-01-30 21:20:13 +00:00
Owner

Summary

  • Add KNOWLEDGE_API.md with complete API documentation
  • Add KNOWLEDGE_DEV.md with development guide
  • Add KNOWLEDGE_USER_GUIDE.md with user documentation
  • Update README.md with knowledge module overview

Test plan

  • Documentation is accurate and complete
  • All links and references are valid
  • Formatting is consistent

Closes #80

## Summary - Add KNOWLEDGE_API.md with complete API documentation - Add KNOWLEDGE_DEV.md with development guide - Add KNOWLEDGE_USER_GUIDE.md with user documentation - Update README.md with knowledge module overview ## Test plan - [x] Documentation is accurate and complete - [x] All links and references are valid - [x] Formatting is consistent Closes #80
jason.woltje added 6 commits 2026-01-30 21:18:55 +00:00
Quality Rails provides mechanical enforcement of code quality through
pre-commit hooks and CI/CD pipelines, preventing ~70% of common issues.

What's added:
- Pre-commit hooks via husky (formatting enforcement enabled)
- Enhanced ESLint rules (no-explicit-any, security plugin, etc.)
- lint-staged configuration (currently formatting-only mode)
- Woodpecker CI pipeline template (.woodpecker.yml)
- eslint-plugin-security for vulnerability detection
- Documentation (docs/quality-rails-status.md)

Current status:
- Strict enforcement DISABLED until existing violations are fixed
- Found 1,226 violations (1,121 errors, 105 warnings)
- Priority: Fix explicit 'any' types first
- Pre-commit currently only enforces Prettier formatting

Next steps:
1. Fix existing lint violations
2. Enable strict pre-commit enforcement
3. Configure CI/CD pipeline

Based on quality-rails from ~/src/quality-rails (monorepo template)
See docs/quality-rails-status.md for detailed roadmap.

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Strict enforcement now active:
- Format all changed files (auto-fix)
- Lint entire packages that have changed files
- Type-check affected packages
- Block commit if ANY warnings or errors

Impact: If you touch a file in a package with existing violations,
you must clean up the entire package before committing.

This forces incremental cleanup while preventing new violations.

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
BREAKING CHANGE: Strict lint enforcement is now ACTIVE

Pre-commit hooks now block commits if:
- Affected package has ANY lint errors or warnings
- Affected package has ANY type errors

Impact: If you touch a file in a package with existing violations,
you MUST fix ALL violations in that package before committing.

This forces incremental cleanup:
- Work in @mosaic/shared → Fix all @mosaic/shared violations
- Work in @mosaic/api → Fix all @mosaic/api violations
- Work in clean packages → No extra work required

Fixed regex to handle absolute paths from lint-staged.

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Strict enforcement is now ACTIVE and blocking commits.

Updated documentation to reflect:
- Pre-commit hooks are actively blocking violations
- Package-level enforcement strategy
- How developers should handle blocked commits
- Next steps for incremental cleanup

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Remove deprecated shebang that will fail in husky v10.

Before (deprecated):
  #!/bin/sh

After (v10-compatible):
  Direct commands without shebang

Ref: https://github.com/typicode/husky/issues/1476

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
docs: add knowledge module documentation (closes #80)
Some checks failed
ci/woodpecker/push/woodpecker Pipeline failed
ci/woodpecker/pr/woodpecker Pipeline failed
955bed91ed
- Created KNOWLEDGE_USER_GUIDE.md with comprehensive user documentation
  - Getting started, creating entries, wiki-links
  - Tags and organization, search capabilities
  - Import/export, version history, graph visualization
  - Tips, best practices, and permissions

- Created KNOWLEDGE_API.md with complete REST API reference
  - All endpoints with request/response formats
  - Authentication and permissions
  - Detailed examples with curl and JavaScript
  - Error responses and validation

- Created KNOWLEDGE_DEV.md with developer documentation
  - Architecture overview and module structure
  - Database schema with all models
  - Service layer implementation details
  - Caching strategy and performance
  - Wiki-link parsing and resolution system
  - Testing guide and contribution guidelines

- Updated README.md with Knowledge Module section
  - Feature overview and quick examples
  - Links to detailed documentation
  - Performance metrics
  - Added knowledge management to overview

All documentation includes:
- Real examples from codebase
- Code snippets and API calls
- Best practices and workflows
- Cross-references between docs
jason.woltje merged commit 26a7175744 into develop 2026-01-30 21:20:13 +00:00
jason.woltje deleted branch feature/knowledge-docs 2026-01-30 21:20:13 +00:00
Sign in to join this conversation.