Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Run the three scripts against an app checkout at the `main` the change describes

- **A change that documents an app change** opens as a draft pull request whose description names the app pull request (`TableProApp/TablePro#1234`). CI checks against the app's `main`, so it goes green once the app pull request merges; mark it ready then.
- **The daily run** catches an app change that broke a claim here. Fix the page, not the check.
- **Releases.** The `release` skill in the app repository pushes the version's `<Update>` block in `changelog.mdx` straight to `main`. Every version in the app's `CHANGELOG.md` must be on that page.
- **Releases.** For each stable release, the app's `release` skill opens a `docs(changelog): vX.Y.Z` pull request whose `<Update>` block in `changelog.mdx` is written by the app's `scripts/release/notes.py docs`, and merges it once the release is published. Every version in the app's `CHANGELOG.md` must be on that page.

## Writing style

Expand Down
8 changes: 4 additions & 4 deletions installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@ title: Installation
description: Install TablePro via Homebrew or DMG on macOS 13.0+
---

Homebrew is the short route: `brew install --cask tablepro` picks the build that matches your Mac. Everyone else takes the DMG, and that is the one route where you match the architecture yourself.
Homebrew is the short route: `brew install --cask tablepro`. Everyone else takes the DMG.

## System requirements

- **macOS**: 13.0 (Ventura) or later
- **Architecture**: Apple Silicon (M1 or later) or Intel x86_64
- **Architecture**: Apple Silicon (M1 or later) or Intel x86_64, one universal app for both

Native Apple frameworks only, so there is no Java or .NET runtime to install first. The download is about 20 MB.

Expand All @@ -24,8 +24,8 @@ brew uninstall --zap tablepro # remove the app and its data
## The DMG

<Steps>
<Step title="Download the asset for your Mac">
Release assets carry the version and the architecture: `TablePro-<version>-arm64.dmg` and `TablePro-<version>-x86_64.dmg`. Check which you need under **Apple menu > About This Mac**, where Chip means Apple Silicon and Processor means Intel. Both are on [GitHub Releases](https://github.com/TableProApp/TablePro/releases).
<Step title="Download the DMG">
Download `TablePro-<version>.dmg` from [GitHub Releases](https://github.com/TableProApp/TablePro/releases). The same file runs on every supported Mac.
</Step>
<Step title="Drag it to Applications">
Open the DMG and drag **TablePro** onto the **Applications** shortcut.
Expand Down
12 changes: 4 additions & 8 deletions scripts/check-docs-against-source.py
Original file line number Diff line number Diff line change
Expand Up @@ -220,14 +220,10 @@ def check_pluginkit_version(root: Path, docs: Path) -> list[str]:
def check_changelog_parity(root: Path, docs: Path) -> list[str]:
"""Every release in CHANGELOG.md must appear on the changelog page.

The two are not copies of each other and must not be generated from one another:
0.67.0 is 201 terse entries in CHANGELOG.md and 113 merged, longer ones on the
page, because the page is edited for readers and the file is edited for the
release notes. What they must agree on is which versions exist.

The check is deliberately one-way. The page may carry a version the file does not,
which is how 0.39.0 is documented: it was tagged and shipped, failed to launch with
errno 163, and 0.39.1 replaced it the same day.
The app's scripts/release/notes.py docs writes each stable's block from its CHANGELOG.md
section. The check stays one-way: the page may carry a version the file does not, which is
how 0.39.0 is documented. It shipped, failed to launch with errno 163, and 0.39.1 replaced it
the same day.
"""
shipped = set(
re.findall(r"^## \[([0-9][^\]]*)\]", (root / "CHANGELOG.md").read_text(), re.M)
Expand Down
Loading