Skip to content

chore(doc): require 'path:' prefix for seedSdk - #1380

Open
alekseifedotov wants to merge 2 commits into
mainfrom
aleksei/update-doc-seeksdk
Open

alekseifedotov wants to merge 2 commits into
mainfrom
aleksei/update-doc-seeksdk

Conversation

@alekseifedotov

Copy link
Copy Markdown
Contributor

If the seekSdk is inside of workdir and there is no 'path:' prefix, it will fail to find the sdk

@github-actions

github-actions Bot commented Sep 2, 2026

Copy link
Copy Markdown

No concrete correctness or merge-blocking issues found in the PR changes.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates onboarding guidance to ensure Nix reliably resolves the local Seek Thermal SDK input by requiring the path: prefix when overriding seekSdk.

Changes:

  • Document using path:PATH_FROM_STEP_3 for --override-input seekSdk to avoid Nix resolving to a git repo root unexpectedly.
  • Update .envrc.example to show path: usage in VENDORED_SEEK_PATH.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File Description
docs/src/first-time-setup.md Clarifies the path: prefix requirement and explains the failure mode when the SDK path is inside a git repo.
.envrc.example Updates the example SDK override variable to include the path: prefix.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread .envrc.example Outdated
Comment thread docs/src/first-time-setup.md
@github-actions

github-actions Bot commented Sep 3, 2026

Copy link
Copy Markdown

No concrete correctness, security, or regression issues found in the PR changes. The documented path: prefix and quoted variable usage are consistent with Nix and direnv behavior.

@alekseifedotov
alekseifedotov force-pushed the aleksei/update-doc-seeksdk branch from 3705de9 to 751842e Compare September 4, 2026 18:06
@github-actions

github-actions Bot commented Sep 4, 2026

Copy link
Copy Markdown

No concrete correctness, security, or merge-blocking issues found in the documentation-only changes.

@alekseifedotov alekseifedotov added the difficulty:trivial I'm too young to die label Sep 4, 2026
alekseifedotov and others added 2 commits September 4, 2026 15:48
If the seekSdk is inside of workdir and there is no 'path:' prefix, it
will fail to find the sdk
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@alekseifedotov
alekseifedotov force-pushed the aleksei/update-doc-seeksdk branch from 751842e to ef190fe Compare September 4, 2026 22:48
@github-actions

github-actions Bot commented Sep 4, 2026

Copy link
Copy Markdown

No concrete issues found. The documentation and .envrc.example consistently add the required path: prefix.

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

Labels

difficulty:trivial I'm too young to die

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants