Skip to content

CXP-1130: Correct last-activity examples in connector docs - #30

Merged
luisina-santos merged 2 commits into
mainfrom
luisinasantos/fix-last-activity-docs-examples
Sep 21, 2026
Merged

luisina-santos merged 2 commits into
mainfrom
luisinasantos/fix-last-activity-docs-examples

Conversation

@luisina-santos

Copy link
Copy Markdown
Contributor

Problem

The Sync member last activity section of docs/connector.mdx illustrated last activity with examples the GitHub organization audit log does not record:

...the most recent recorded action across all synced organizations (for example, commenting on an issue or pull request, reviewing code, or changing a setting).

Two of those three examples cannot produce a last-activity date. Measured on both include=web and include=all, issue and pull request comments and code reviews produce no audit-log events at all. Administrative actions do.

The same error appeared a second time in the Git-operations paragraph, whose parenthetical (no PR reviews, comments, or settings changes) read as though reviews and comments would otherwise have counted.

The section already stated correctly that unrecorded activity yields no date, so the page contradicted itself: it explained the rule and then gave examples that violate it.

Impact

Silent and user-facing. An organization whose members write and review code but administer nothing enables the feature, sees an empty Last login column for every account, and finds nothing in the docs explaining why — the page named their exact workflow as an example of what counts.

Change

Docs only, one file:

  1. Example list replaced with administrative actions that are actually recorded.
  2. New What is not counted paragraph naming comments, reviews and commits explicitly.
  3. Git-operations paragraph reworded so it builds on that rather than contradicting it.

No connector change. The connector surfaces what the audit log returns; only the description of what that covers was wrong.

Notes for the reviewer

  • The existing claim that raw Git operations are excluded "to keep this fast on large organizations" was left as-is — the measurement covers content activity, not the git-events category.
  • Administrative examples: creating a team is what the validation actually exercised and it produced events. Repository create/delete and settings changes were not directly measured.

Found while validating the last-activity feature on v0.0.18 (FIX-05). That test case passes; this was a separate documentation defect.

Closes CXP-1130

🤖 Generated with Claude Code

The Sync member last activity section illustrated last activity with
examples the GitHub organization audit log does not record. Measured on
both include=web and include=all, issue and pull request comments and
code reviews produce no audit-log events, so neither can yield a
last-activity date. The section already stated correctly that unrecorded
activity yields no date, so the page contradicted itself.

Replace the example list with administrative actions that are recorded,
state explicitly that content activity is not counted, and correct the
Git-operations paragraph, whose parenthetical implied reviews and
comments would otherwise have produced a date.

Docs only; no connector change.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@linear-code

linear-code Bot commented Sep 21, 2026

Copy link
Copy Markdown

CXP-1130

Comment thread docs/connector.mdx Outdated
Pushes are recorded in the organization audit log under the git event
category; they are excluded because the feed queries with Include: "web",
which the following paragraph already explains. Listing them as not
recorded attributed the exclusion to the wrong cause.

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

Copy link
Copy Markdown
Contributor

Connector PR Review: CXP-1130: Correct last-activity examples in connector docs

Blocking Issues: 0 | Suggestions: 0 | Threads Resolved: 0
Criteria: Criteria status: loaded .claude/skills/ci-review.md from trusted base 4f6709b28c32.
Review mode: full
View review run

Review Summary

The full PR diff was scanned for security and correctness; it touches a single documentation file (docs/connector.mdx, +4/-2) with no Go, config, go.mod, or go.sum changes. The revised wording matches the implementation: the vendored activity feed queries the organization audit log with an include filter of "web" (vendor/github.com/conductorone/baton-github/pkg/connector/usage_event_feed.go:150-160), so excluding raw Git operations and framing last activity around administrative events is accurate, and the section no longer contradicts its own "unrecorded activity yields no date" rule. No new issues found.

Security Issues

None found.

Correctness Issues

None found.

Suggestions

None.

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No blocking issues found.

@luisina-santos
luisina-santos merged commit ac71327 into main Sep 21, 2026
11 checks passed
@luisina-santos
luisina-santos deleted the luisinasantos/fix-last-activity-docs-examples branch September 21, 2026 16:13
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.

2 participants