Skip to content

Commit a00a59a

Browse files
committed
Fix CI: Prettier formatting, macOS version accuracy, and stricter AGENTS.md
- Fix Prettier table formatting in BROKEN-LINKS-AND-REDIRECTS.md - Add missing trailing newline in network-traffic-monitoring.md - Correct "macOS 26" to "macOS Sequoia (15) and later" in faq.md - Update AGENTS.md with strict pre-push quality gate and knip check
1 parent a772f7c commit a00a59a

File tree

4 files changed

+54
-46
lines changed

4 files changed

+54
-46
lines changed

docs/AGENTS.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,18 @@
11
# Docs Agent Guidelines
22

3-
## After Making Changes
3+
## After Making Changes — Required Quality Gate
44

5-
Always run these checks from the `docs/` directory after modifying files:
5+
CI will **reject** the PR if any of the checks below fail. Always run every check from the `docs/` directory **before** committing and pushing:
66

7-
1. `npm run lint` - Verify ESLint passes
8-
2. `npm run format:check` - Verify Prettier formatting
9-
3. `npm run typecheck` - Verify TypeScript types
10-
4. `npm run build` - Verify production build succeeds
7+
```bash
8+
cd docs
9+
npm run lint # ESLint
10+
npm run format:check # Prettier (fix with: npx prettier --write .)
11+
npm run typecheck # astro check (TypeScript)
12+
npm run build # Production build
13+
npm run knip # Unused files and dependencies
14+
```
15+
16+
If `format:check` fails, run `npx prettier --write .` and commit the result.
17+
18+
All five commands must exit with code 0 before you push.

docs/BROKEN-LINKS-AND-REDIRECTS.md

Lines changed: 38 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -8,28 +8,28 @@ Analysis of all internal doc links and redirects after the docs restructure (com
88

99
Every internal doc link was checked against existing files. **All current link targets have a corresponding page** in the repo.
1010

11-
| Link target | Used in | File exists |
12-
|-------------|---------|-------------|
13-
| `/docs/docs/features/app-actions/app-directory-access` | user-defaults-editor.mdx | ✓ app-directory-access.md |
14-
| `/docs/features/capturing/simulator-camera-support` | setting-up-rocketsim-connect.md ||
15-
| `/docs/features/networking/network-traffic-monitoring` | setting-up-rocketsim-connect.md, network-speed-control.mdx, network-traffic-monitoring.md (Networking Insights), index.mdx ||
16-
| `/docs/features/networking/networking-insights` | network-traffic-monitoring.md ||
17-
| `/docs/getting-started/setting-up-rocketsim-connect` | network-traffic-monitoring.md, simulator-camera-support.md, networking-insights.md, index.mdx ||
18-
| `/docs/docs/features/capturing/app-store-connect-optimization` | recordings.md ||
19-
| `/docs/docs/features/capturing/touch-indicators` | recordings.md ||
20-
| `/docs/docs/features/capturing/floating-thumbnail` | recordings.md, app-store-connect-optimization.md ||
21-
| `/docs/docs/features/build-insights/team-build-insights` | build-insights.md ||
22-
| `/docs/docs/settings/side-window` | onboarding.md ||
23-
| `/docs/getting-started/onboarding` | index.mdx, PageTitle.astro ||
24-
| `/docs/getting-started/product-tour-and-quick-demos` | index.mdx, PageTitle.astro ||
25-
| `/docs/getting-started/how-large-teams-use-rocketsim` | index.mdx ||
26-
| `/docs/features/capturing/screenshots` | index.mdx ||
27-
| `/docs/features/design-comparison/comparing-designs` | index.mdx ||
28-
| `/docs/getting-started/configuring-app-actions` | index.mdx ||
29-
| `/docs/features/accessibility/toggles-and-dynamic-text` | index.mdx ||
30-
| `/docs/settings/side-window` | index.mdx ||
31-
| `/docs/support/faq` | index.mdx, menu.json ||
32-
| `/docs/support/reporting-an-issue` | index.mdx ||
11+
| Link target | Used in | File exists |
12+
| -------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | ------------------------- |
13+
| `/docs/docs/features/app-actions/app-directory-access` | user-defaults-editor.mdx | ✓ app-directory-access.md |
14+
| `/docs/features/capturing/simulator-camera-support` | setting-up-rocketsim-connect.md | |
15+
| `/docs/features/networking/network-traffic-monitoring` | setting-up-rocketsim-connect.md, network-speed-control.mdx, network-traffic-monitoring.md (Networking Insights), index.mdx | |
16+
| `/docs/features/networking/networking-insights` | network-traffic-monitoring.md | |
17+
| `/docs/getting-started/setting-up-rocketsim-connect` | network-traffic-monitoring.md, simulator-camera-support.md, networking-insights.md, index.mdx | |
18+
| `/docs/docs/features/capturing/app-store-connect-optimization` | recordings.md | |
19+
| `/docs/docs/features/capturing/touch-indicators` | recordings.md | |
20+
| `/docs/docs/features/capturing/floating-thumbnail` | recordings.md, app-store-connect-optimization.md | |
21+
| `/docs/docs/features/build-insights/team-build-insights` | build-insights.md | |
22+
| `/docs/docs/settings/side-window` | onboarding.md | |
23+
| `/docs/getting-started/onboarding` | index.mdx, PageTitle.astro | |
24+
| `/docs/getting-started/product-tour-and-quick-demos` | index.mdx, PageTitle.astro | |
25+
| `/docs/getting-started/how-large-teams-use-rocketsim` | index.mdx | |
26+
| `/docs/features/capturing/screenshots` | index.mdx | |
27+
| `/docs/features/design-comparison/comparing-designs` | index.mdx | |
28+
| `/docs/getting-started/configuring-app-actions` | index.mdx | |
29+
| `/docs/features/accessibility/toggles-and-dynamic-text` | index.mdx | |
30+
| `/docs/settings/side-window` | index.mdx | |
31+
| `/docs/support/faq` | index.mdx, menu.json | |
32+
| `/docs/support/reporting-an-issue` | index.mdx | |
3333

3434
**Conclusion:** No broken internal links remain. The fixes applied earlier (index.mdx + simulator-camera-support.md) resolved all invalid targets.
3535

@@ -48,22 +48,22 @@ If the built site serves doc pages under **/docs/docs/...**, then links that use
4848

4949
Redirects cover both possible old URL styles (single and double `docs`) so bookmarks and external links keep working.
5050

51-
| From | To |
52-
|------|----|
53-
| `/docs/features/rocketsim-connect/introduction-and-setup` | `/docs/getting-started/setting-up-rocketsim-connect` |
54-
| `/docs/features/rocketsim-connect/network-traffic-monitoring` | `/docs/features/networking/network-traffic-monitoring` |
55-
| `/docs/appearance/side-window` | `/docs/settings/side-window` |
56-
| `/docs/appearance/shortcuts` | `/docs/settings/shortcuts` |
57-
| `/docs/features/app-actions/general-app-actions` | `/docs/getting-started/configuring-app-actions` |
58-
| `/docs/features/app-actions/build-insights` | `/docs/features/build-insights/build-insights` |
59-
| `/docs/features/app-actions/network-speed-control-and-simulator-airplane-mode` | `/docs/features/networking/network-speed-control` |
60-
| `/docs/docs/features/rocketsim-connect/introduction-and-setup` | `/docs/getting-started/setting-up-rocketsim-connect` |
61-
| `/docs/docs/features/rocketsim-connect/network-traffic-monitoring` | `/docs/features/networking/network-traffic-monitoring` |
62-
| `/docs/docs/appearance/side-window` | `/docs/settings/side-window` |
63-
| `/docs/docs/appearance/shortcuts` | `/docs/settings/shortcuts` |
64-
| `/docs/docs/features/app-actions/general-app-actions` | `/docs/getting-started/configuring-app-actions` |
65-
| `/docs/docs/features/app-actions/build-insights` | `/docs/features/build-insights/build-insights` |
66-
| `/docs/docs/features/app-actions/network-speed-control-and-simulator-airplane-mode` | `/docs/features/networking/network-speed-control` |
51+
| From | To |
52+
| ----------------------------------------------------------------------------------- | ------------------------------------------------------ |
53+
| `/docs/features/rocketsim-connect/introduction-and-setup` | `/docs/getting-started/setting-up-rocketsim-connect` |
54+
| `/docs/features/rocketsim-connect/network-traffic-monitoring` | `/docs/features/networking/network-traffic-monitoring` |
55+
| `/docs/appearance/side-window` | `/docs/settings/side-window` |
56+
| `/docs/appearance/shortcuts` | `/docs/settings/shortcuts` |
57+
| `/docs/features/app-actions/general-app-actions` | `/docs/getting-started/configuring-app-actions` |
58+
| `/docs/features/app-actions/build-insights` | `/docs/features/build-insights/build-insights` |
59+
| `/docs/features/app-actions/network-speed-control-and-simulator-airplane-mode` | `/docs/features/networking/network-speed-control` |
60+
| `/docs/docs/features/rocketsim-connect/introduction-and-setup` | `/docs/getting-started/setting-up-rocketsim-connect` |
61+
| `/docs/docs/features/rocketsim-connect/network-traffic-monitoring` | `/docs/features/networking/network-traffic-monitoring` |
62+
| `/docs/docs/appearance/side-window` | `/docs/settings/side-window` |
63+
| `/docs/docs/appearance/shortcuts` | `/docs/settings/shortcuts` |
64+
| `/docs/docs/features/app-actions/general-app-actions` | `/docs/getting-started/configuring-app-actions` |
65+
| `/docs/docs/features/app-actions/build-insights` | `/docs/features/build-insights/build-insights` |
66+
| `/docs/docs/features/app-actions/network-speed-control-and-simulator-airplane-mode` | `/docs/features/networking/network-speed-control` |
6767

6868
If the live site uses **/docs/docs/...** for docs, update the **To** column (and `astro.config.ts`) to use that pattern (e.g. `/docs/docs/getting-started/setting-up-rocketsim-connect`).
6969

docs/src/content/docs/docs/features/networking/network-traffic-monitoring.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,4 +41,4 @@ Basically, yes! However, RocketSim does not yet allow configuring breakpoints or
4141

4242
## Powered by open-sourced framework Pulse
4343

44-
Network monitoring is made possible by [Pulse](https://github.com/kean/Pulse), an open-sourced library developed by [Alex Grebenyuk](https://github.com/kean). For a more advanced Network Logger that includes powerful mocking capabilities, advanced filtering, and more — check out [Pulse Pro](https://pulselogger.com/).
44+
Network monitoring is made possible by [Pulse](https://github.com/kean/Pulse), an open-sourced library developed by [Alex Grebenyuk](https://github.com/kean). For a more advanced Network Logger that includes powerful mocking capabilities, advanced filtering, and more — check out [Pulse Pro](https://pulselogger.com/).

docs/src/content/docs/docs/support/faq.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ This is usually caused by missing system permissions.
6565

6666
2. Open **System Settings → Privacy & Security** and approve any pending **RocketSim** permissions.
6767
3. Open System Settings → Network → Filter and verify whether RocketSim is present & enabled
68-
4. On **macOS 26**, enable the Network Extension:
68+
4. On **macOS Sequoia (15) and later**, enable the Network Extension:
6969
- **System Settings → General → Login Items & Extensions**
7070
- Find **RocketSim**, click **(i)**, and enable **Network Extension**
7171
You may need to approve permissions more than once.

0 commit comments

Comments
 (0)