Skip to content

feat(docs): days-based lookback for sync-docs (v1.2.0) - #10

Closed
Fl0p wants to merge 1 commit into
mainfrom
flo-502-sync-docs-days
Closed

feat(docs): days-based lookback for sync-docs (v1.2.0)#10
Fl0p wants to merge 1 commit into
mainfrom
flo-502-sync-docs-days

Conversation

@Fl0p

@Fl0p Fl0p commented Jul 21, 2026

Copy link
Copy Markdown
Contributor

Summary

  • /docs:sync-docs now defaults to 1 day lookback instead of 5 commits
  • A plain number (e.g. /docs:sync-docs 7) is interpreted as days
  • Commit count mode requires explicit commits suffix (e.g. /docs:sync-docs 10commits)
  • Bumps docs plugin version to 1.2.0

Test plan

  • /docs:sync-docs — runs git log --since="1 days ago"
  • /docs:sync-docs 3 — runs git log --since="3 days ago"
  • /docs:sync-docs 10commits — runs git log -10
  • /docs:sync-docs 1commit — runs git log -1

Closes FLO-502

Summary by CodeRabbit

  • New Features

    • Updated documentation synchronization to support either day-based or commit-count-based change windows.
    • Added clearer guidance for updating documentation from current file contents, including examples, API details, and links.
  • Documentation

    • Improved the documented workflow and argument handling for the documentation sync command.
  • Chores

    • Updated the documentation plugin version from 1.1.1 to 1.2.0.

Default argument is now days (1 day if omitted). Explicit commit count
mode requires the `commits` suffix (e.g. `10commits`). Bumps plugin
version to 1.2.0.

Co-Authored-By: Daedalus <daedalus@agents.flopbut.local>
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Jul 21, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

The docs sync command now supports day-based and commit-count-based modes, documents updated current-content validation and reporting steps, and increments the plugin manifest version to 1.2.0.

Changes

Documentation sync update

Layer / File(s) Summary
Sync command workflow
plugins/docs/commands/sync-docs.md
The command now parses day or commit-count arguments, builds the corresponding git log command, updates documentation from current file contents, validates references, and reports changes.
Plugin version metadata
plugins/docs/.claude-plugin/plugin.json
The plugin version changes from 1.1.1 to 1.2.0.

Estimated code review effort: 1 (Trivial) | ~5 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly matches the main change: /docs:sync-docs now uses a days-based lookback and the plugin version is bumped to 1.2.0.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch flo-502-sync-docs-days

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 3

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@plugins/docs/.claude-plugin/plugin.json`:
- Line 3: Update the version reported in the docs plugin catalog manifest to
1.2.0, matching the version in plugin.json. Modify the catalog entry in
docs/plugin-catalog/docs-plugin.md and leave other metadata unchanged.

In `@plugins/docs/commands/sync-docs.md`:
- Around line 9-16: Update the `/docs:sync-docs` command documentation in the
plugin catalog entry to match the contract shown in `sync-docs.md`: document the
default one-day lookback, interpret unsuffixed numbers as days, and describe
`commit`/`commits` suffixed values as commit counts. Remove the outdated
commit-only `[number_of_commits]` wording while preserving the command’s
existing catalog context.
- Around line 13-25: Define validation immediately after parsing $ARGUMENTS and
before constructing the git log command: reject zero or negative values,
non-numeric input, and unsupported suffixes. On rejection, explain the accepted
formats (positive day counts or positive commit counts using commit/commits),
ask the user to retry, and do not run git log.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 84676502-197d-42bf-9199-6069ad9ce6e6

📥 Commits

Reviewing files that changed from the base of the PR and between e140e86 and 08dcd1d.

📒 Files selected for processing (2)
  • plugins/docs/.claude-plugin/plugin.json
  • plugins/docs/commands/sync-docs.md

Comment thread plugins/docs/.claude-plugin/plugin.json
Comment thread plugins/docs/commands/sync-docs.md
Comment thread plugins/docs/commands/sync-docs.md
@Fl0p

Fl0p commented Jul 21, 2026

Copy link
Copy Markdown
Contributor Author

Superseded by #11 (FLO-505, re-cut of FLO-503). This PR is on the stale flo-502-sync-docs-days branch (based on pre-ksef/pre-worktree main) and contains only a partial pass: 10commits no-space syntax instead of the CTO-specified 10 commits keyword, no empty-window guard, Usage line not updated, and no docs/plugin-catalog/docs-plugin.md update. #11 implements the full verbatim spec off current main with correct commit identity. Closing to keep one feature = one PR.

@Fl0p

Fl0p commented Jul 21, 2026

Copy link
Copy Markdown
Contributor Author

Closing without merge — superseded.

The days-based /docs:sync-docs feature this PR implements already landed on main via commit 0d86f20 ("♻️ Make /docs:sync-docs window days-based by default", the FLO-503 branch): the docs plugin is at 1.2.0, the command window is days-by-default with an opt-in commits keyword, and the plugin catalog page is updated to match.

Merging this PR now would duplicate and conflict with that change (both touch the same three files) and regress the on-main N commits syntax, so it is not merged. For the record, the CodeRabbit findings raised here — catalog version sync, catalog command contract, and invalid-argument handling — are all satisfied on main, and commit 5a3a692 on this branch also addressed each of them.

Feature delivery for the parent (FLO-502) is complete on main. Closing as superseded.

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.

1 participant