Skip to content

docs: correct what the docs claim the pipeline does - #26

Merged
tkoehlerlg merged 1 commit into
mainfrom
docs/refresh-stale-docs
Sep 24, 2026
Merged

tkoehlerlg merged 1 commit into
mainfrom
docs/refresh-stale-docs

Conversation

@tkoehlerlg

Copy link
Copy Markdown
Contributor

Docs-only, no code changes. Each of these was verifiably wrong rather than merely thin.

docs/api-reference.md

  • The Busy Time Handling section described the pre-0.6.0 pipeline — "busy times are automatically merged", "padding is applied before merging". That is the precise model the maxOverlaps bug lived inside: under maxOverlaps they are deliberately not merged, because the count is how many busy times cover a moment and merging two overlapping ones caps it at one.
  • Time Alignment claimed slots align to slotSplit boundaries when offset is 0. They do not — they start at the beginning of the search range.
  • maxOverlaps was defined as "traditional behavior applies", a phrase defined nowhere. It now says what the option is for: capacity. Three people who can each take a meeting is maxOverlaps: 2.
  • Added that busy times are validated on ingest and throw.

docs/availability-scheduler.md — the wall-clock rule, which is what 0.7.1 changed.

ARCHITECTURE.md — stops listing internal.types.ts and errors.ts, neither of which exists.

CLAUDE.md — stops naming ESLint and Prettier for a repo that uses Biome, and stops pinning a version five minors out of date.

Version bumped to 0.7.2 because version-check now runs on every PR and requires a version ahead of npm — a consequence of the change in #24. Publishing is a separate step; this does not release itself.

Untracked and left alone: NPM_PUBLISH_SETUP.md and RELEASE_SECURITY.md still describe the NPM_TOKEN flow that OIDC replaced. They are not in the repo, so they are local residue worth deleting.

🤖 Generated with Claude Code

The API reference still described the pre-0.6.0 pipeline — busy times always
merged, padding applied after — which is the exact model the maxOverlaps bug
lived inside. Under maxOverlaps they are deliberately not merged, because the
count is how many busy times cover a moment and merging two into one interval
caps that count at one.

It also said slots align to slotSplit boundaries when offset is zero. They do
not: they start at the beginning of the search range. And it defined maxOverlaps
as 'traditional behavior applies', a phrase defined nowhere; it now says what the
option is for, which is capacity — three people who can each take a meeting is
maxOverlaps: 2.

The availability guide gains the wall-clock rule, ARCHITECTURE stops listing two
files that do not exist, and CLAUDE.md stops naming ESLint and Prettier for a
repo that uses Biome, or pinning a version five minors old.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@codecov

codecov Bot commented Sep 24, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@tkoehlerlg
tkoehlerlg merged commit 23d8de1 into main Sep 24, 2026
6 checks passed
@tkoehlerlg
tkoehlerlg deleted the docs/refresh-stale-docs branch September 24, 2026 21:24
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