Repository navigation
docs: rewrite the domain docs for budgets, entries and suggestions - #96
Open
claude-for-timatic[bot] wants to merge 16 commits into
Open
claude-for-timatic[bot] wants to merge 16 commits into
claude-for-timatic[bot] wants to merge 16 commits into
Conversation
…read pointers Claude
Contributor
Author
|
Pruned every page with the criterion from the review: a bullet stays only when it says something the code cannot (the why, an invariant, or a deliberate surprise). Of the nine bullets on the notifications page four remain; across all pages roughly half are gone and the goal paragraphs absorbed the one-clause facts worth keeping. The index states the criterion so future bullets are held to it. |
This was referenced Nov 7, 2026
…tures live in the API Claude
…and event type Issue #41 drops the event type from the chain rule, so the activities page and the glossary describe the stretch, not the app it was observed in. Claude
This was referenced Nov 8, 2026
…twice Overlap across customers is acceptable multitasking and planned in #33; the current projector forbids all overlap, which the page now says is stricter than intended. Claude
This was referenced Nov 8, 2026
tomasvanrijsse
self-requested a review
November 9, 2026 07:17
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #95
Replaces
docs/high-level-design.mdanddocs/business-rules.md, which predated the day-based projection and described things that no longer exist, with one page per concept:docs/README.md(index, page shape) anddocs/GLOSSARY.mddocs/budgets/: overview, versions, periods, usage, notificationsdocs/entries/: overview, locked-dates, time-spent, daily-progressdocs/suggestions/: overview (one end-to-end example), events, activities, suggestions, lifecycledocs/integration-oauth.mdmoved from.claude/docs/, content unchanged (Align the integration OAuth doc with how integrations store tokens #75 records the decision to migrate the code to it)Every page opens with the goal and what must stay true, then the rules as bullets naming the edge case and the test that pins it. Prose stays free of class names so the sibling repos can read it; the "Where in the code" footer names classes and tests. A script checked that every relative link, test name and code path in the pages resolves.
Also: a Concepts section in the README (the rebundle section no longer names a listener that does not exist), and must-read pointers per area in CLAUDE.md.
Two rules have no pinning test yet and say so: the one-time-budget and backdated-version rules in
budgets/versions.md, and daily progress.Follow-up after merge: GitHub URL pointers in the CLAUDE.md of timatic-frontend, timatic-extension, timatic-claude, timatic-php-sdk and timatic-jira.
Claude