Skip to content

docs: add CLI reference, database schema, and developer guide#266

Merged
d-oit merged 1 commit into
mainfrom
docs/phase-1-documentation
Jun 5, 2026
Merged

docs: add CLI reference, database schema, and developer guide#266
d-oit merged 1 commit into
mainfrom
docs/phase-1-documentation

Conversation

@d-oit
Copy link
Copy Markdown
Owner

@d-oit d-oit commented Jun 5, 2026

Summary

Phase 1 of issue #237 — creates the three highest-priority documentation files.

New Files

  • docs/CLI.md: Comprehensive CLI reference documenting all 20 commands with arguments, options, examples, shared database setup, and troubleshooting.
  • docs/DATABASE.md: Database schema reference with ASCII ER diagram, all 8 tables, FTS5 search tables, migration history, and index reference.
  • docs/DEVELOPMENT.md: Developer onboarding guide with prerequisites, project structure, commands, quality workflow, git workflow, architecture overview, common tasks, and troubleshooting.

Validation

  • 0 lint errors ✅
  • Typecheck clean ✅
  • Code reviewer approved ✅

Closes #237 (Phase 1)

- docs/CLI.md: Comprehensive CLI reference for all 20 commands
- docs/DATABASE.md: Schema reference with ER diagram, tables, migrations
- docs/DEVELOPMENT.md: Developer onboarding, project structure, common tasks

Closes #237 (Phase 1)

Co-authored-by: d-oit <6849456+d-oit@users.noreply.github.com>
@github-actions github-actions Bot added documentation Documentation improvements config labels Jun 5, 2026
@deepsource-io
Copy link
Copy Markdown

deepsource-io Bot commented Jun 5, 2026

DeepSource Code Review

We reviewed changes in 207bab4...980fb36 on this pull request. Below is the summary for the review, and you can see the individual issues we found as inline review comments.

See full review on DeepSource ↗

PR Report Card

Overall Grade   Security  

Reliability  

Complexity  

Hygiene  

Code Review Summary

Analyzer Status Updated (UTC) Details
JavaScript Jun 5, 2026 2:29p.m. Review ↗
Python Jun 5, 2026 2:29p.m. Review ↗
Shell Jun 5, 2026 2:29p.m. Review ↗
SQL Jun 5, 2026 2:29p.m. Review ↗

Important

AI Review is run only on demand for your team. We're only showing results of static analysis review right now. To trigger AI Review, comment @deepsourcebot review on this thread.

@codacy-production
Copy link
Copy Markdown
Contributor

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.

@d-oit d-oit merged commit 45eb237 into main Jun 5, 2026
22 checks passed
@d-oit d-oit deleted the docs/phase-1-documentation branch June 5, 2026 14:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

config documentation Documentation improvements

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Documentation] Create comprehensive documentation suite

2 participants