Skip to content

docs: add build and installation instructions to README#1

Open
felipereisdev wants to merge 1 commit intobeyondcode:mainfrom
felipereisdev:add-build-and-install-docs
Open

docs: add build and installation instructions to README#1
felipereisdev wants to merge 1 commit intobeyondcode:mainfrom
felipereisdev:add-build-and-install-docs

Conversation

@felipereisdev
Copy link

Summary

  • Expands the README with step-by-step instructions for building the extension from source
  • Documents all available npm scripts (build, dev, typecheck, package)
  • Adds instructions for loading the unpacked extension in Chrome, including the Alt+Shift+P shortcut

Copy link

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: ee1d4277e9

ℹ️ 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".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment on lines +27 to +30
```bash
cd packages/chrome-extension
npm install
npm run build

Choose a reason for hiding this comment

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

P2 Badge Build the extension against the checked-out SDK sources

These commands install @polyscope/sdk from npm, not from this checkout: packages/chrome-extension/package-lock.json:800-802 pins the dependency to the published sdk-0.1.0.tgz, and packages/chrome-extension/src/background/index.ts:8 imports that package directly. In practice, someone following this new “Building from Source” section will get a bundle that ignores any local edits under src/sdk/, so it is easy to validate the wrong code after making source changes in this repo.

Useful? React with 👍 / 👎.

Comment on lines +50 to +53
3. Click **Load unpacked**
4. Select the `packages/chrome-extension/dist/` folder

The extension icon will appear in your Chrome toolbar. Click it to toggle in-page tools on or off. You can also activate the element picker with the keyboard shortcut `Alt+Shift+P`.

Choose a reason for hiding this comment

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

P2 Badge Document how users actually open the Polyscope panel

The install section currently stops at loading the unpacked extension and then says to click the toolbar icon, but the code does not expose the panel that way: packages/chrome-extension/public/manifest.json:13-21 has no default_popup, and packages/chrome-extension/src/background/index.ts:851-865 uses left-click to toggle in-page tools while the actual panel is only available from the action context menu. For a first-time user, following these steps leaves no documented path to sign in or choose a workspace, so the extension appears unusable after installation.

Useful? React with 👍 / 👎.

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.

1 participant