Skip to content

docs: add project knowledge index #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
pekth wants to merge 3 commits into
base: main
Choose a base branch
from
+28 −0
Open

docs: add project knowledge index #12

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c38ab15
docs: add project knowledge index
pekth Aug 24, 2026
9003b78
no-mistakes(review): Corrected unsupported release and credential claims
pekth Aug 24, 2026
de615c9
no-mistakes(document): Backfill knowledge index evidence boundaries
pekth Aug 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions docs/KB.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Project knowledge

Last verified: 2026-08-24

Source revision: `9003b78beecb051c7d31334602ecf59982c1e7da`

## Evidence boundary

This index records the meterusage source and documentation at the source revision above. Source, assembled bundle, installed app, GitHub release, and runtime behavior are separate evidence layers. One layer does not prove the others.

## Current source and document state

meterusage is a macOS menu-bar app that reads local and documented aggregate provider usage signals. The README documents source build and demo mode. Privacy boundaries are explicit: no direct Codex/Claude credential read; OpenRouter uses an existing key; Grok re-reads its CLI OIDC token; no prompts or code are sent; cost figures are estimates. This index does not establish release, installation, or runtime evidence.

## Best references

- [Repository README](../README.md)
- [Privacy and security design](PRIVACY.md)
- [Demo mode](DEMO.md)
- [Companion file guide](COMPANION.md)
- [Contributor guide](../CONTRIBUTING.md)
- [Changelog](../CHANGELOG.md)

## Open verification gaps

- Current source-to-bundle identity is not established by this index.
- Installed app identity, GitHub release assets, and runtime provider behavior require separate current proof.
- Provider availability, account state, network responses, and estimated costs are not release or billing truth.