Skip to content

docs: document 0.17.0 release#435

Merged
wesm merged 3 commits into
mainfrom
0.17.0-docs
Jul 5, 2026
Merged

docs: document 0.17.0 release#435
wesm merged 3 commits into
mainfrom
0.17.0-docs

Conversation

@wesm

@wesm wesm commented Jul 5, 2026

Copy link
Copy Markdown
Member

Why

0.17.0 shipped a broad set of user-facing surfaces, and the existing docs only covered part of the release. The release notes and docs need to match the implementation so users can discover backup, Teams sync, message-type filtering, scoped embeddings, and the daemon/API changes from the public site.

What changed

  • Adds a full 0.17.0 changelog entry with code-verified entries and contributor acknowledgements.
  • Adds a dedicated Microsoft Teams guide covering Graph permissions, tokens, sync/backfill commands, scheduling, search, and embeddings.
  • Expands README, setup, CLI, API, config, search/query, MCP, vector-search, calendar, TUI, text-message, index, and architecture docs for the 0.17.0 surfaces.

Validation

  • make docs-check

Deploy

Docs deployment is manual after merge: run make docs-deploy (or the project's docs deploy flow) so the public site picks up the release docs.

0.17.0 added several user-facing surfaces that were only partially covered by the existing site. Capture the release notes and bring the public docs in line with the actual CLI, API, config, and daemon behavior so users can discover backup, Teams sync, message-type filtering, scoped embeddings, and the daemon-era changes from one place.

The Teams guide and expanded references spell out the concrete command flags, token locations, scheduler behavior, and API filters verified against the implementation, while the changelog credits contributors from the release PRs.

Generated with Codex
Co-authored-by: Codex <codex@openai.com>
@roborev-ci

roborev-ci Bot commented Jul 5, 2026

Copy link
Copy Markdown

roborev: Combined Review (8390e57)

Documentation changes are mostly clean, with two medium-severity accuracy issues to fix.

Medium

  • README.md:232, docs/cli-reference.md:490

    • Problem: The backup example initializes a repo with --repo, then runs create, verify, and restore without --repo or a configured [backup].repo. backup init does not persist that path, so the follow-up commands fail for a new user.
    • Fix: Add --repo ~/Backups/msgvault to the follow-up commands, or include the config step before omitting --repo.
  • docs/api-server.md:224

    • Problem: The docs say /api/v1/messages/gmail-ids accepts the same filters as /messages/filter, but the Gmail-ID query only honors a subset and ignores filters such as message_type, after/before, attachments_only, offset, and sort. API users can receive a broader ID set than documented.
    • Fix: Either implement the missing filters in GetGmailIDsByFilter, or narrow the docs to the filters that endpoint actually honors.

Reviewers: 2 done | Synthesis: codex, 8s | Total: 4m17s

wesm and others added 2 commits July 4, 2026 20:31
- MCP search_messages/list_messages have no message_type parameter;
  scoping goes through the message_type: query operator, and only
  find_similar_messages takes a dedicated parameter
- get_message windowing pages the response body, it does not bound
  server memory; document the actual paging parameters
- Scheduled [[gcal]] syncs bypass the run_after_sync embed hook;
  calendar events are embedded via the embed worker cron instead
- backup init does not persist [backup].repo, so quick-start examples
  now pass --repo explicitly and point to the config key

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
GetGmailIDsByFilter only applies sender/sender_name, recipient/
recipient_name, domain, label, source_id, and limit; it is hardwired
to Gmail sources, always excludes deleted messages, and ignores the
other /messages/filter parameters.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@roborev-ci

roborev-ci Bot commented Jul 5, 2026

Copy link
Copy Markdown

roborev: Combined Review (4c1c2e7)

Summary verdict: No Medium, High, or Critical findings to report.

All reported issues are below the requested severity threshold.


Reviewers: 2 done | Synthesis: codex, 4s | Total: 9m57s

@wesm wesm merged commit a939980 into main Jul 5, 2026
11 checks passed
@wesm wesm deleted the 0.17.0-docs branch July 5, 2026 01:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

1 participant