Skip to content

docs: refresh project documentation - #94

Merged
llbbl merged 1 commit into
mainfrom
docs/86-91-docs-refresh
Aug 24, 2026
Merged

docs: refresh project documentation#94
llbbl merged 1 commit into
mainfrom
docs/86-91-docs-refresh

Conversation

@llbbl

@llbbl llbbl commented Aug 24, 2026

Copy link
Copy Markdown
Owner

Summary

  • refocus the README into a concise, value-first landing page for the project
  • move setup, deployment, and reference detail into dedicated docs pages
  • refresh semantic search docs with stable provider-contract and 384-dimension embedding wording

Changes

Documentation

  • README.md: shorten the project entrypoint and link to detailed documentation
  • docs/README.md: add the docs index for deeper guides
  • docs/GETTING_STARTED.md: document installation, local setup, and indexing flow
  • docs/DEPLOYMENT.md: document deployment requirements and build/index steps
  • docs/REFERENCE.md: centralize configuration and operational reference details
  • content/features/semantic-search.md: correct embedding and provider-contract language
  • content/theme/overview.md: refresh theme/content docs for the current project framing

Validation

  • pnpm format
  • pnpm lint
  • pnpm exec tsc --noEmit
  • pnpm test:coverage --run (178 passed, 96.54% lines)
  • pnpm db:init:local
  • pnpm index:local
  • TURSO_DB_URL=file:local.db TURSO_AUTH_TOKEN=local pnpm build
  • Local link target checks
  • Independent docs review PASS after one finding was fixed

Closes #86
Closes #91

@codecov

codecov Bot commented Aug 24, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 91.21%. Comparing base (dcd7abb) to head (6c0a519).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #94   +/-   ##
=======================================
  Coverage   91.21%   91.21%           
=======================================
  Files          12       12           
  Lines         330      330           
  Branches       86       86           
=======================================
  Hits          301      301           
  Misses         11       11           
  Partials       18       18           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@llbbl
llbbl merged commit b537d05 into main Aug 24, 2026
6 checks passed
@llbbl
llbbl deleted the docs/86-91-docs-refresh branch August 24, 2026 12:07
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.

docs: refocus README as a concise project landing page Update stale embedding documentation

1 participant