docs: define QueueIt extension architecture

Open
#3 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
65/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Active
Tech stack
react

Research direction

Start by locating the popup/options UI, background/service worker, Queue Engine, Local Storage, Platform Adapter, and Content Script entry points named in the issue, then trace their message flow and lifecycle. Document the runtime boundaries, error propagation, storage ownership, adapter contracts, browser compatibility, and permissions so a developer can follow one prompt through the ChatGPT page and back to the queue engine.

Written by the indexing model from the issue text.

Description

Objective

Document the production architecture for the browser extension.

Required architecture

React popup/options UI
        |
        v
Extension background/service worker
        |
        v
Queue Engine <----> Local Storage
        |
        v
Platform Adapter
        |
        v
Content Script
        |
        v
Supported AI website

Rules

  • Queue engine must not contain ChatGPT DOM selectors.
  • ChatGPT-specific behavior belongs behind an adapter.
  • Content scripts own page DOM interaction.
  • Background/service worker owns orchestration and durable queue state.
  • Popup is a presentation/control surface and must not own long-running execution.
  • Browser APIs should use WXT's cross-browser abstraction where practical.
  • Chrome and Firefox should use one source tree.
  • No direct dependency on undocumented ChatGPT backend APIs for the MVP.

Document

Explain:

  • runtime boundaries
  • message passing
  • lifecycle
  • error propagation
  • storage ownership
  • adapter contracts
  • browser compatibility
  • extension permissions

Acceptance criteria

A developer can trace one prompt from the popup through the queue engine, content script, ChatGPT page, completion event, and back to the queue engine.

Dominant language
CSS
Stars
0
Forks
0
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

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 ChinmayOnGithub/queueit

All issues in ChinmayOnGithub/queueit

Similar issues

More DevTools issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.