Skip to content

doc#167 — Mark the QSG datasheet link as requiring a SiMa.ai sign-in - #168

Merged
shanguangzai merged 1 commit into
developfrom
doc/qsg-datasheet-login-167
Nov 15, 2026
Merged

shanguangzai merged 1 commit into
developfrom
doc/qsg-datasheet-login-167

Conversation

@hannatorianyk-hash

@hannatorianyk-hash hannatorianyk-hash commented Nov 13, 2026 •

Copy link
Copy Markdown
Contributor

Closes #167

Summary

On the "Inside The DevKit" step of the Quick Start Guide, the "SiMa SOM Carrier Board Data Sheet (PDF)" link redirects to auth.sima.ai (HTTP 302) without warning, so the link looked broken. The same PDF is listed with SiMa.ai account access on Reference Documents.

Before After
For detailed pinout and hardware information, see the SiMa SOM Carrier Board Data Sheet (PDF). For detailed pinout and hardware information, see the SiMa SOM Carrier Board Data Sheet (PDF) (sign-in with a SiMa.ai account required). For all hardware documents and their access requirements, see Reference Documents.

The new Reference Documents link explains the access levels and lists public alternatives, such as the DevKit Product Brief.

Only static/tools/qsg/index.html changes. The QSG is static, English-only HTML, so there are no locale files to update. Making the PDF public, the issue's other option, depends on docs.sima.ai access settings and is outside this repo.

Change Type

  • Bug fix
  • Refactor
  • Feature
  • Docs
  • Test-only
  • Build/CI
  • Breaking change

Risk

  • Low
  • Medium
  • High

Test Evidence

SYSDOC_STRICT_LINKS=1 npx docusaurus build  exit 0, all 5 locales; build/tools/qsg/index.html contains the sign-in note
curl developer.sima.ai/hardware/reference/extra-docs  200
curl <datasheet PDF>                                  302 -> auth.sima.ai/authorize

npm run check:i18n-complete does not apply, because no translated files change. npm run check:language fails on the existing ko ROS 2 assertion; that is unrelated to this change and fixed by #153 (still open).

Docs Impact

  • No docs update needed
  • Docs updated in this PR
  • Docs follow-up required (linked issue)

Migration Impact

  • No migration impact
  • Migration required and documented

Breaking API Change

  • Not applicable
  • This PR changes public API signatures under include/*

API / Deprecation Checklist

  • Public API unchanged
  • Public API changed with deprecation path documented under docs/develop-apps/
  • Naming contract respected (docs/develop-apps/contribute/start-here/naming.md)

The "Inside The DevKit" step linked to the carrier board datasheet, which
redirects to auth.sima.ai with no warning, so the link looked broken.
Add a sign-in note matching the "SiMa.ai account" access label on the
Reference Documents page, and link to that page for access details.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Nov 13, 2026 •

Copy link
Copy Markdown
Codex Review Summary: ✅ Completed

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-11-13T14:20:31.434795Z cfa91da PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@hannatorianyk-hash
hannatorianyk-hash changed the base branch from main to develop November 13, 2026 14:26
@shanguangzai
shanguangzai self-requested a review November 15, 2026 21:30
@shanguangzai
shanguangzai merged commit 5a40bf8 into develop Nov 15, 2026
1 of 4 checks passed
@shanguangzai
shanguangzai deleted the doc/qsg-datasheet-login-167 branch November 15, 2026 21:30
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.

[DOC] Datasheet link in the Quick Start Guide opens a login page with no warning

2 participants