Skip to content

Point the content conventions at the shared docs home #21

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

Merged
CuWilliams merged 1 commit into from
Sep 14, 2026
Merged

Point the content conventions at the shared docs home #21

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
26 changes: 22 additions & 4 deletions Claude.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -314,12 +314,24 @@ Dynamic content will be managed via JSON files in `/data/`:

## Content Conventions

**The product-wide rules live in
[`gfpricechecker/CONTENT_CONVENTIONS.md`](https://github.com/CuWilliams/shared-docs/blob/main/gfpricechecker/CONTENT_CONVENTIONS.md)
in the shared-docs repo**, which governs this site, the iOS app, and any future Android app.
Change them there, not here. The shared repo also holds
[`PRODUCT_DEFINITION.md`](https://github.com/CuWilliams/shared-docs/blob/main/gfpricechecker/PRODUCT_DEFINITION.md)
— the data model, the differential arithmetic and the export formats — which is the reference when
copy needs to describe how the app actually computes something.

The sections below are the short version of the shared rules, plus the parts that are specific to
this site. The tax-compliance rule is repeated rather than merely linked because it is legal
exposure, and you should not have to open another repo to find out about it.

### Don't claim tax compliance

The app deliberately carries no Canada Revenue Agency branding in its interface. Agency references
and specific tax line numbers were stripped out in April 2026 — tracking price differences is what
the app does, and what a user does with those records at tax time is between them and their
accountant. **The site follows the same rule.**
accountant. **The site follows the same rule**, and has since v1.2.0 removed this class of claim.

- Explain the Medical Expense Tax Credit as context for why the app exists. That's fair and useful.
- Never describe the app's exports as CRA-compliant, approved, accepted, or endorsed.
Expand All @@ -328,8 +340,10 @@ accountant. **The site follows the same rule.**

Before merging copy changes, sweep for regressions:

```
grep -rn "CRA\|Tax Compliant\|tax compliance\|Line 33099" --include=*.html --include=*.json .
```bash
# Quote the --include patterns: zsh expands them as globs otherwise.
grep -rn "CRA\|Tax Compliant\|tax compliance\|Line 33099" \
--include='*.html' --include='*.json' .
```

Every surviving hit should be explanatory context, never a claim about the app's output.
Expand All @@ -356,7 +370,11 @@ PR). The static pages have no such prompt and are the ones that quietly rot —
### Don't overclaim on privacy either

Local-only storage, on-device text recognition, no accounts, no sync: all true, all worth saying.
But backup files are **not** encrypted. Don't say they are.
But backup files are **not** encrypted, and neither is the stored tax ID. Don't say they are.

The full posture, including what is *not* covered, is in the shared
[`CONTENT_CONVENTIONS.md`](https://github.com/CuWilliams/shared-docs/blob/main/gfpricechecker/CONTENT_CONVENTIONS.md)
§4. If the app's posture changes, that file changes first.

### Use the canonical host in every absolute URL

Expand Down
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,8 @@ The check exists because these failures are otherwise invisible: a malformed fil

The app deliberately carries no Canada Revenue Agency branding in its interface — tracking price differences is the app's job, and what a user does with those records at tax time is between them and their accountant. **The site follows the same rule.** Explain the Medical Expense Tax Credit as context for why the app exists, but don't describe the app's output as CRA-compliant, approved, or endorsed, and don't promise anyone a deduction.

That rule is not this repo's to change. It lives in [`gfpricechecker/CONTENT_CONVENTIONS.md`](https://github.com/CuWilliams/shared-docs/blob/main/gfpricechecker/CONTENT_CONVENTIONS.md) in the shared-docs repo, which governs this site, the iOS app, and any future Android app — along with the shared vocabulary and the platform-independent product definition. It is repeated here because it is legal exposure, not because this is where it is decided.

Beyond that, see [DESIGN-SYSTEM.md](DESIGN-SYSTEM.md) for design tokens and component patterns, and [Claude.md](Claude.md) for the fuller set of working notes.

## Releases
Expand Down
Loading