Update BotLab's README and CONTRIBUTING for the monorepo and live site

Open Beginner friendly
  • Is something wrong?
#1,144 1 comment 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

@KanishJebaMathewM is already working on this.

Since Nov 2, 2026.

  • #1185 by @KanishJebaMathewM — open

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
75/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
html
Domain
documentation

Research direction

Start with botlab/README.md (around line 24, line 126 and the "open index.html directly" step) and botlab/CONTRIBUTING.md (around line 65), then check botlab/wrangler.toml for the deploy setup and skim botlab/3D/ to describe the gesture mode. Replace the old repo links, add the local-run steps (npx wrangler dev or python3 -m http.server) and the live URL, and remove emoji from headings. Done when a grep of botlab/ finds no alphaonelabs-virtual-robotics-playground, the local-run steps work from a fresh clone, and the 3D section is in the README.

Written by the indexing model from the issue text.

Description

2026-11 documentation good first issue gsoc-2027 project: botlab
Context

BotLab's docs still describe the old standalone repo:

  • botlab/README.md line 24 and botlab/CONTRIBUTING.md line 65 clone or add alphaonelabs/alphaonelabs-virtual-robotics-playground; README line 126 links issues there.
  • README says to "open index.html directly", but the site is deployed from botlab/ at https://botlab.alphaonelabs.com via wrangler.toml (static assets), and the 3D/gesture mode in botlab/3D/ isn't mentioned at all.
What to do
  • Replace old repo links with alphaonelabs/website (cd website/botlab), and point issue links at issues labelled project: botlab.
  • Document running locally with npx wrangler dev (or python3 -m http.server), and add the live URL.
  • Add a short section on 3D/ (what it is, controls, camera permission for hand gestures).
  • Remove emoji from headings to match the brand guidelines (https://design.alphaonelabs.com).
Acceptance criteria
  • No references to alphaonelabs-virtual-robotics-playground remain in botlab/.
  • The README's local-run steps work from a fresh clone.
  • The 3D mode is documented.
Files
  • botlab/README.md
  • botlab/CONTRIBUTING.md
Helpful links

Part of GSoC 2027 onboarding — see https://gsoc.alphaonelabs.com

Dominant language
HTML
Stars
66
Forks
181
Avg merge
2h 21m
Merged PRs (30d)
13

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from alphaonelabs/website

All issues in alphaonelabs/website

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.