Skip to content

Mention AI features in README's Overview and Features sections - #98

Merged
danibsheehan merged 1 commit into
mainfrom
docs/readme-ai-features
Aug 30, 2026
Merged

Mention AI features in README's Overview and Features sections#98
danibsheehan merged 1 commit into
mainfrom
docs/readme-ai-features

Conversation

@danibsheehan

Copy link
Copy Markdown
Owner

Summary

The AI layer (search, summarize, related pages, usage indicator) was only documented in the "Deploy musing-ai-service" setup section, ~180 lines into the README — a reader browsing Overview/Features top-to-bottom would never learn it exists. `readme.mdc` requires Features to reflect shipped UI, and this has been live and merged since #94/#95.

  • Overview: one new paragraph, matching the existing Supabase-sync paragraph's style — optional, additive, points to the existing deploy section.
  • Features: one new bullet alongside the Supabase-sync bullet.

Test plan

  • `check_stack_docs.py`, `npm run format:check` — pass
  • Docs-only change

🤖 Generated with Claude Code

The AI layer (search, summarize, related pages, usage indicator) was
only documented in the "Deploy musing-ai-service" setup section, ~180
lines in — a reader browsing Overview/Features top-to-bottom would
never learn it exists. readme.mdc requires Features to reflect shipped
UI, and this has been live and merged since #94/#95.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@github-actions

Copy link
Copy Markdown

PR guide

Auto-generated from changed paths. Fill in Summary and How to verify in the PR description above.

Touches: docs / agent guidance

Diff: 1 file changed, 4 insertions(+), 1 deletion(-)

Suggested verify

  • N/A - docs/tooling only; confirm locally if anything user-facing changed

Checklist (applies to this PR)

  • No unintended secrets or local-only config committed

Reviewer focus

  • Scope looks docs- or tooling-only; confirm there is no hidden runtime impact

Commits

  • d16d484 Mention AI features in README's Overview and Features sections

Files by area

Area Files
docs / agent guidance 1

CI

Primary check: CI runs lint, Prettier format check, Vitest coverage, and build for every PR. Coverage tables are posted separately.


Template: pull_request_template.md

@github-actions github-actions Bot added the area: docs Documentation or agent guidance label Aug 30, 2026
@github-actions

Copy link
Copy Markdown

Unit tests (Vitest)

File Coverage Lines Branches
All files 55% 63% 48%
src/components/DatabaseEmbedNodeView.tsx 0% 0% 0%
src/components/DatabaseTableView.tsx 0% 0% 0%
src/components/SidebarSearch.tsx 63% 76% 51%
src/components/SlashMenu.tsx 72% 85% 60%
src/context/WorkspaceContext.tsx 25% 35% 14%
src/extensions/blockIdOnBlocks.ts 75% 100% 50%
src/extensions/musingDatabaseEmbed.ts 70% 90% 50%
src/extensions/singleTopLevelBlock.ts 80% 100% 60%
src/hooks/usePageIndexing.ts 95% 90% 100%
src/lib/aiClient.ts 81% 86% 76%
src/lib/blockEditorCommands.ts 42% 50% 35%
src/lib/blockPlainText.ts 55% 60% 50%
src/lib/editorBlockText.ts 13% 13% 14%
src/lib/emojiSuggestionItems.ts 93% 100% 87%
src/lib/htmlToDocx.ts 24% 31% 18%
src/lib/pageToExportHtml.ts 97% 100% 94%
src/lib/resolveWikiPage.ts 91% 100% 83%
src/lib/slashMenuOptions.ts 57% 57% 0%
src/lib/themePreference.ts 32% 25% 40%
src/lib/workspaceStorage.ts 80% 81% 80%
src/lib/pageDocument/blockGutterOps.ts 92% 100% 84%
src/lib/pageDocument/blockIdAtSelection.ts 83% 100% 66%
src/lib/pageDocument/lastBlockNeedsBelowHit.ts 91% 100% 83%
src/lib/pageDocument/serializeDocToBlocks.ts 58% 69% 47%
src/lib/pageDocument/slashMenuDeleteRange.ts 82% 95% 70%
src/lib/pageDocument/tryDeleteEmptyTopLevelBlock.ts 87% 94% 81%

Minimum allowed coverage is 0%

Generated by 🐒 cobertura-action against d16d484

@danibsheehan
danibsheehan merged commit 9a220f5 into main Aug 30, 2026
8 checks passed
@danibsheehan
danibsheehan deleted the docs/readme-ai-features branch August 30, 2026 22:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area: docs Documentation or agent guidance

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant