docs: specify queue state machine and persistence

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

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Domain
documentation

Research direction

No files or tests are named in the issue. Start with the required Queue and Item states, transitions, persistence fields, and browser-restart recovery cases; done means the documented state machine is deterministic, testable without a real ChatGPT page, and prevents unverified advancement.

Written by the indexing model from the issue text.

Description

Objective

Define queue behavior before implementation.

Required states

Queue:

idle | running | paused | stopped | completed | failed

Item:

pending | sending | generating | completed | failed | skipped

Required transitions

Document valid and invalid transitions for:

  • start
  • pause
  • resume
  • stop
  • retry
  • skip
  • browser restart
  • tab refresh
  • ChatGPT navigation
  • extension reload

Persistence

Document what is stored in browser.storage.local, including:

  • queue metadata
  • prompt text
  • item status
  • current item
  • timestamps
  • last known execution state
  • schema version

Do not store secrets or unnecessary page data.

Recovery

The design must define what happens if the browser closes while a prompt is generating. QueueIt must never silently advance to the next prompt without evidence that the previous one completed.

Acceptance criteria

The state machine is deterministic and testable without a real ChatGPT page.

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 Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.