Docs/adding documentation

[arxja]

Summary by CodeRabbit

• Documentation
  • Added comprehensive contribution guidelines and Code of Conduct link.
  • Added Getting Started guide with installation and basic setup instructions.
  • Added API documentation for core, server, and client packages.
  • Added system architecture overview and end-to-end data flow documentation.
  • Updated README with explicit links to documentation files.
  • Removed outdated template content from example and dashboard READMEs.

[coderabbitai]

Warning

Review limit reached

@arxja, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 12 minutes and 30 seconds. Learn how PR review limits work.

Your organization has run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 1574fdcb-42f0-41d2-b491-416b8e1bea78

📥 Commits

Reviewing files that changed from the base of the PR and between 6592748 and fe64cbd.

⛔ Files ignored due to path filters (1)

• pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml

📒 Files selected for processing (14)

• .github/workflows/ci.yml
• CONTRIBUTING.md
• docs/client.md
• examples/bun-server-demo/index.ts
• package.json
• packages/core/tests/queue.test.ts
• packages/core/tsconfig.json
• packages/dashboard/app/page.tsx
• packages/dashboard/components/JobRow.tsx
• packages/dashboard/hooks/useDashboard.ts
• packages/dashboard/lib/api.ts
• packages/dashboard/tsconfig.json
• packages/dashboard/types/type.ts
• pnpm-workspace.yaml

📝 Walkthrough

Walkthrough

This PR establishes the documentation foundation for JetQueue by introducing a complete getting started guide, API references for all three packages, system architecture overview, and contribution guidelines. The README is updated to link to these new documentation pages, creating a coherent information architecture for users and contributors.

Changes

Project Documentation Suite

Layer / File(s)	Summary
Documentation hub and links README.md	README documentation section now references concrete paths to Getting Started, API references (core, server, client), and Architecture docs instead of placeholders.
Getting started guide docs/getting-started.md	New page covering installation of @jet-queue/core, creating a queue instance with concurrency settings, adding a named async job, listening for drain events, starting the server with Bun, installing and connecting the client, and links to further API documentation.
System architecture overview docs/architecture.md	New documentation describing JetQueue package roles (@jet-queue/core, @jet-queue/server, @jet-queue/client, @jet-queue/cli, @jet-queue/dashboard) and a data-flow diagram for job submission and completion notifications via HTTP and WebSocket.
API reference documentation docs/core.md, docs/server.md, docs/client.md	New API docs for core queue (constructor options, job configuration, events, storage backends), server (Quick Start, REST endpoints, WebSocket events), and client SDK (installation, usage examples, available methods for job lifecycle and real-time events).
Contribution guidelines CONTRIBUTING.md	New file with full contribution workflow including Code of Conduct, bug report and feature suggestion processes, PR requirements with test/type-check commands, development setup prerequisites, local build/test/demo instructions, project structure, Conventional Commit examples, style guide rules, and licensing notice.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A burrow of docs so neat and clear,
Getting started without any fear,
APIs mapped from core to client and server wide,
With architecture as our trusty guide,
And contributions welcomed with open paws!
✨

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title is vague and generic, using non-descriptive language ('Docs/adding documentation') that doesn't convey what specific documentation was added or the primary purpose of the changes.	Use a more specific title that describes the key documentation additions, such as 'Add comprehensive documentation for JetQueue packages and getting started guide' or 'Document core, server, and client APIs with architecture overview'.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch docs/adding-documentation

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 3

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@CONTRIBUTING.md`:
- Line 57: The code fence showing the test command in CONTRIBUTING.md is missing
a language identifier and triggers markdownlint MD040; update the fenced block
that contains the test command (the ``` block with "bun test") to include the
language identifier "bash" (i.e., change ``` to ```bash) so the snippet is
recognized as shell script.
- Line 44: Update the Node.js prerequisite in CONTRIBUTING.md to match the
repository engine requirement: change the "Node.js 20+" note to the minimum
required by packages/core/package.json (Node >=22.5.0). Locate the mention of
Node.js in CONTRIBUTING.md and replace the version text so it reads the same
constraint as packages/core/package.json (>=22.5.0) and optionally add a short
note referencing the engine requirement in package.json for future sync.

In `@docs/client.md`:
- Line 26: The methods list contains malformed inline code spans with extra
spaces and stray commas inside backticks (e.g., "` retryJob(id)`,` getStats()`"
and "`disconnect()`,` onJobCompleted`"); fix by removing inner spaces and stray
punctuation so each method is wrapped as its own clean backtick span (e.g.,
`addJob(handler, options?)`, `getJob(id)`, `getJobProgress(id)`,
`cancelJob(id)`, `retryJob(id)`, `getStats()`, `health()`, `connect()`,
`disconnect()`, `onJobCompleted(id, cb)`, `onJobFailed(id, cb)`,
`onJobProgress(id, cb)`, `onEvent(type, cb)`) ensuring no extra spaces inside
backticks and proper commas between entries.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 3877c887-f672-4b4e-b9af-1703eb1495ae

📥 Commits

Reviewing files that changed from the base of the PR and between 80be180 and 6592748.

📒 Files selected for processing (9)

• CONTRIBUTING.md
• README.md
• docs/architecture.md
• docs/client.md
• docs/core.md
• docs/getting-started.md
• docs/server.md
• examples/split-screen-demo/README.md
• packages/dashboard/README.md

💤 Files with no reviewable changes (2)

• packages/dashboard/README.md
• examples/split-screen-demo/README.md