Skip to content

docs: broken links and omissions found from automated review #240

Description

@madebydavid

I tasked an agent to review the docs and look for mistakes - review is below

Agent review

I audited README.md, DEVELOPMENT.md, and all 77 files in docs/ against the command sources in src/commands/, and regenerated the reference pages with bin/dev.js internal readme <tmp> -d 2 --notDryRun --overWrite to diff them against what is committed.

Some fixes belong in the docs. Some belong in the command source, because the reference pages copy description and examples from there.

Wrong information

  • docs/apple.md — all 8 anchor links use #shipthis-apple-apikey-create. The real anchor is #apple-apikey-create. Every link lands at the top of the page. docs/game/ios/profile.md:37 uses the correct form.
  • docs/apple.md — omits apple apiKey delete, apple certificate delete, and apple certificate show.
  • docs/game.md — the Topics list omits game android. Readers cannot reach the keystore or Google Play pages from it.
  • docs/game/details.md:18 — says androidPackageName is "not currently used". It is used in src/utils/ship/index.ts:72, src/baseCommands/baseGameAndroidCommand.ts:32, and src/components/GameStatus.tsx:63.
  • README.md:259 — says game ios app sync covers "Access WiFi, Push Notifications". src/utils/godot.ts:44-48 also syncs Increased Memory Limit and Game Center, plus the keys parsed from entitlements/additional. docs/game/ios/app.md already has the correct table.
  • README.md — the iOS wizard list has 7 steps. src/commands/game/ios/wizard.ts runs 8. It omits shipthis game ios app addTester --self.
  • src/commands/game/android/apiKey/import.tsx:23 — the example shipthis game android apiKey import omits the required FILE argument, so the documented command fails.
  • src/commands/game/android/apiKey/export.tsx:19 — the example writes to keyStore.zip, but the command exports a Service Account API key.
  • docs/game/ship.md:36 — "executes the build ... but applies ShipThis certificates" contradicts itself. The flag applies demo credentials instead of your own. The paragraph also omits that --useDemoCredentials implies --skipPublish.

Typos

Location Text Fix
src/commands/game/ios/app/sync.tsx:12 "Synchronies the Apple App" "Synchronizes" (also reaches the CLI help)
docs/game/ios/app/sync.md:5 &#34;BundleId&#34; EJS escaping. COMMAND_TEMPLATE in src/commands/internal/readme.tsx:67 uses <%= %> for the description; use <%- %>
5 files "generally in the currently directory" "current directory" — docs/game/status.md:5, docs/game/job.md:3, docs/game/ios.md:5, docs/game/ios/app.md:3, docs/game/ios/profile.md:3
docs/apple/certificate.md:9 "You can more about Certificates" "You can read more about"
docs/apple.md:26 "their corresponding the private keys" drop "the"
package.json, topic game:android:apiKey "Commands related to they Android" "the"
docs/game/details.md:5 "are used by when your game is built" "are used when"
src/commands/game/ios/profile/import.tsx:20 "Imports an Mobile Provisioning Profile" "a Mobile Provisioning Profile"
docs/README.md:20 "Signin or create a new account" "Sign in" (matches README.md:387)

Stale generated pages

npm run readme never overwrites, so each topic page and its command pages hold two copies of the same help block, and the copies have drifted. About 20 commands are affected. Most of the diff is flag order, but three changes are real:

  • oclif now prints optional arguments as [FILE] and [COMMAND...]. The docs still print FILE and COMMAND... in docs/game/android/keyStore/import.md, docs/game/android/keyStore.md, and docs/help.md.
  • docs/apple/status.md:22 misses the final period the source now has.
  • docs/login.md:26-27 wraps --acceptAgreements over two lines. It now fits on one.

Two options: drop the duplicated help from the topic pages, or run the generator with --overWrite in CI and fail on a diff.

14 command pages also still use the old # apple apiKey create heading instead of the current # Command: `apple apiKey create` template output.

Minor

  • README.md and docs/README.md describe the same topics differently — util is "do not require authentication" vs "do not require login" (docs/README.md:14); apiKey differs too (docs/README.md:11).
  • docs/game/android/keyStore.md:100 adds "You can import as JKS and password parameters or as a ZIP file", which the command page and the source description do not have. The sentence is useful — move it into the command description so both pages get it.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions