Skip to content

docs: fix inaccurate instructions and broken references - #432

Open
DaniilSmirnov wants to merge 1 commit into
VKCOM:masterfrom
DaniilSmirnov:docs/fix-inaccurate-documentation
Open

DaniilSmirnov wants to merge 1 commit into
VKCOM:masterfrom
DaniilSmirnov:docs/fix-inaccurate-documentation

Conversation

@DaniilSmirnov

Copy link
Copy Markdown

Correct documentation that no longer matched the code:

  • README (en/ru): the production stack is served on ports 80/443 via nginx, not 8082; provider example used a non-existent --public-url flag; removed links to missing "troubleshooting" and "recommended hardware" anchors; license line said "All Rights Reserved" while the project is Apache-2.0; fixed a broken bold marker and stale "2025" roadmap wording; Node.js requirement now matches CI and Dockerfile.
  • CONTRIBUTING: there is no npm test script; point to lint and typecheck, which CI runs.
  • doc/TESTING: test/ui -> test/e2e, --exit-code-from flag typo, base URL semantics for the API tests.
  • mongo.md and docker-compose docs: correct MongoDB version notes, add the required --env-file, fix the non-existent devicehub-processor001 service name, and document that services with container_name cannot be scaled as written.
  • Autotests and Appium how-tos: endpoints are GET/DELETE /api/v1/autotests (not /autotests/captureDevices|freeDevices), and the Python client base_url must include /api/v1.
  • API.md: consistent heading for the remoteConnect DELETE endpoint.
  • iOS device doc: correct helper script path, drop unsupported ios-provider flags, and point to npm run setup-wda.
  • units-describe: fix "prooxy" -> "poorxy" and stray words.
  • group-roles: rewrite to match hasGroupEditPermission and the moderator/owner logic in the code.
  • Python client README: replace template placeholders with DeviceHub examples.

Correct documentation that no longer matched the code:

- README (en/ru): the production stack is served on ports 80/443 via
  nginx, not 8082; provider example used a non-existent --public-url
  flag; removed links to missing "troubleshooting" and "recommended
  hardware" anchors; license line said "All Rights Reserved" while the
  project is Apache-2.0; fixed a broken bold marker and stale "2025"
  roadmap wording; Node.js requirement now matches CI and Dockerfile.
- CONTRIBUTING: there is no `npm test` script; point to lint and
  typecheck, which CI runs.
- doc/TESTING: test/ui -> test/e2e, `--exit-code-from` flag typo,
  base URL semantics for the API tests.
- mongo.md and docker-compose docs: correct MongoDB version notes,
  add the required --env-file, fix the non-existent
  devicehub-processor001 service name, and document that services with
  container_name cannot be scaled as written.
- Autotests and Appium how-tos: endpoints are GET/DELETE
  /api/v1/autotests (not /autotests/captureDevices|freeDevices), and the
  Python client base_url must include /api/v1.
- API.md: consistent heading for the remoteConnect DELETE endpoint.
- iOS device doc: correct helper script path, drop unsupported
  ios-provider flags, and point to npm run setup-wda.
- units-describe: fix "prooxy" -> "poorxy" and stray words.
- group-roles: rewrite to match hasGroupEditPermission and the
  moderator/owner logic in the code.
- Python client README: replace template placeholders with DeviceHub
  examples.
@DaniilSmirnov
DaniilSmirnov requested a review from a team as a code owner October 30, 2026 20:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants