Skip to content

docs: extend docs-tests coverage to storage and the rest of the account section - #2989

Open
marcel-rbro wants to merge 3 commits into
docs/fix-docs-tests-settings-pathfrom
docs/docs-tests-storage-account
Open

marcel-rbro wants to merge 3 commits into
docs/fix-docs-tests-settings-pathfrom
docs/docs-tests-storage-account

Conversation

@marcel-rbro

@marcel-rbro marcel-rbro commented Sep 17, 2026

Copy link
Copy Markdown
Contributor

Part of #2671. Stacked on #2988 — retargets to master once that merges.

Widens the baseline from 3 pages / 38 assertions to 11 / 87: storage (overview, datasets, key-value stores, request queues) and the remaining account pages (2FA, promo codes, general resource access, organization usage). Also folds in the abandoned docs/docs-tests-detail-fixtures branch, giving 7 previously-skipped assertions a landing route.

Two harness bugs this surfaced:

  • Slug derivation. .mdx kept its extension, and an index.md page produced account-settings-index instead of overwriting account-settings — so re-extracting a page that became a directory would write a second baseline file beside the first, and both would be evaluated. Now strips .mdx/.md and a trailing /index, using two plain substitutions since \.mdx\?$ matches nothing under BSD sed (macOS).
  • Stale storage routes in the extractor's route table. /storage?tab=keyValueStores returns 200 but redirects to the datasets tab; Console serves /storage/key-value-stores. Every re-extraction would have regenerated a wrong at.

The same stale URLs appear in the storage docs themselves, where they send readers to the wrong tab. That's a prose fix — separate PR.

Verified against staging: 139 passed · 0 failed · 35 skipped, 0 issues. The skips are element assertions with no landing route (storage/Actor detail pages, connector modals), which need the seeded fixtures from #2671.

🤖 Generated with Claude Code

https://claude.ai/code/session_01FSj1mTUbMKgmu2JoGJLSKD

@marcel-rbro marcel-rbro added documentation Improvements or additions to documentation. t-docs Issues owned by technical writing team. labels Sep 17, 2026
@marcel-rbro marcel-rbro self-assigned this Sep 17, 2026
@marcel-rbro

Copy link
Copy Markdown
Contributor Author

Folded in docs/docs-tests-detail-fixtures (pushed 2026-07-28, never opened as a PR). That branch predates both the IA v3 path refresh and this expansion, so it conflicted with all three account baselines — the at-routes are reapplied here rather than rebased, and the branch can be deleted.

Gives a landing route to the dashboard sections (/), the billing Pricing and Invoices tabs, and the Settings Referrals tab. All 7 verified against staging, including the billing routes, which were never checked when the original branch was written.

Updated totals: 139 passed · 0 failed · 35 skipped (was 132 / 42).

The remaining 35 skips need the seeded-user fixtures from #2671, not an at-route — storage and Actor detail pages, connector modals, and the 2FA enabled-state controls.

marcel-rbro and others added 2 commits September 17, 2026 16:17
…nt section

Widens the docs-tests baseline from 3 pages / 38 assertions to 11 pages /
87 assertions, adding the storage section and the account pages that were
never covered.

New pages:

- storage: overview, datasets, key-value stores, request queues
- account: two-factor authentication, promo codes, general resource
  access, organization usage

Harness fixes this surfaced:

- scripts/extract.sh derived the slug with `s#\.md$##`, so an .mdx page
  kept its extension and an index page became `account-settings-index`
  rather than overwriting `account-settings` — a re-extraction would have
  written a second baseline file beside the existing one and both suites
  would have loaded them. Now strips .mdx/.md and a trailing /index. The
  expression uses two plain substitutions instead of `\.mdx\?$`, which
  matches nothing under BSD sed (macOS, where the extractor is run).
- prompts/extract-system.md pointed the storage tabs at
  `/storage?tab=datasets`, `?tab=keyValueStores` and `?tab=requestQueues`.
  Console serves `/storage/datasets`, `/storage/key-value-stores` and
  `/storage/request-queues`; the query-param URLs return 200 but redirect
  to the datasets tab, so every re-extraction would have regenerated an
  `at` route that lands on the wrong page. Route table corrected.

The same stale URLs appear in the storage docs themselves, where they send
readers to the wrong tab. That is genuine drift and a prose fix, so it is
left to its own PR rather than bundled here.

Curation notes for the new baseline:

- Left-nav items (Storage, Proxy) are anchors, not buttons, and there is no
  element_link kind — dropped rather than mis-typed.
- "Include unnamed storages" is a checkbox label, not a button.
- 2FA Disable/Recovery settings describe the enabled state; the seeded user
  has 2FA off, so they are fixture-gated (no `at`) instead of failing.
- Assertions already covered by the account baseline were not duplicated,
  and generic targets ("ID", "Actions") that match arbitrary page text were
  removed.

Verified against staging: 132 passed, 0 failed, 42 skipped, 0 issues. The
skips are element assertions with no landing route — the pre-existing
detail-page-fixture gap, now larger because storage detail pages carry many
of the documented labels.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01FSj1mTUbMKgmu2JoGJLSKD
Folds in the work from docs/docs-tests-detail-fixtures, which was pushed
2026-07-28 and never opened as a PR. That branch predates both the IA v3
path refresh and this coverage expansion, so it conflicts with all three
account baselines; the at-routes are reapplied here rather than rebased.

Gives a landing route to the dashboard sections (/), the billing Pricing
and Invoices tabs, and the Settings Referrals tab, so they evaluate
instead of skipping. All 7 verified against staging — including the
billing routes, which were never checked when the original branch was
written.

Skips drop from 42 to 35; passes rise from 132 to 139, 0 failures.

The remaining 35 are element assertions with no atomic landing route:
storage and Actor detail pages, connector modals, and the 2FA
enabled-state controls. Those need the seeded-user fixtures from #2671,
not an at-route.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01FSj1mTUbMKgmu2JoGJLSKD
@apify-service-account

apify-service-account commented Sep 17, 2026

Copy link
Copy Markdown
Contributor

✅ Preview for this PR (commit 114ddb81) is ready at https://pr-2989.preview.docs.apify.com (see action run).

…ests

sources/platform/integrations/** documents third-party interfaces, not
Console. Those pages carry the highest bold-label density in the docs, so
any scan looking for testable UI labels ranks them first — and every one
of them is a dead end: the harness can't reach those products, their UIs
change on someone else's schedule, and a failure would be unactionable.

Writes the rule into the "adding a new test case" guide next to the
existing marketing-site exclusion, and notes that this caps what the
harness can ever cover — about half of sources/platform/ — so coverage
is not misread as a share of all docs.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01FSj1mTUbMKgmu2JoGJLSKD
@TC-MO

TC-MO commented Sep 21, 2026

Copy link
Copy Markdown
Contributor

Here I'd wait, I have a big storage rewrite #2975 in the works that is to be merged soon

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation. t-docs Issues owned by technical writing team.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants