Skip to content

docs: add full query parameter matrix#3346

Closed
REHAN-503 wants to merge 116 commits into
JhaSourav07:mainfrom
REHAN-503:docs/query-param-matrix
Closed

docs: add full query parameter matrix#3346
REHAN-503 wants to merge 116 commits into
JhaSourav07:mainfrom
REHAN-503:docs/query-param-matrix

Conversation

@REHAN-503
Copy link
Copy Markdown

Description

This PR improves the README by consolidating query parameter documentation into a single, easy-to-scan reference table.

Changes Made

  • Reorganized the parameter documentation into a unified matrix
  • Added default values for all documented parameters
  • Added allowed values and constraints where applicable
  • Added practical copy-paste-friendly examples
  • Added a cross-link to the theme documentation for easier navigation
  • Kept documentation consistent with existing behavior

Fixes #239

Pillar

  • 🛠️ Other (Bug fix, refactoring, docs)

Visual Preview

N/A – Documentation-only change.

Checklist before requesting a review:

  • I have read the CONTRIBUTING.md file.
  • I have tested these changes locally (localhost:3000/api/streak?user=YOUR_USERNAME).
  • I have run npm run format and npm run lint locally and resolved all errors (CI will fail otherwise).
  • My commits follow the Conventional Commits format.
  • I have updated README.md.
  • I have started the repo.
  • I have made sure that I have only one commit to merge in this PR.
  • The SVG output matches the CommitPulse "premium quality" aesthetic standard.
  • (Recommended) I joined the CommitPulse Discord community.

@vercel
Copy link
Copy Markdown
Contributor

vercel Bot commented Jun 3, 2026

@REHAN-503 is attempting to deploy a commit to the jhasourav07's projects Team on Vercel.

A member of the Team first needs to authorize it.

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Jun 3, 2026

👋 Hey @REHAN-503, welcome to CommitPulse! 🎉

Thanks for opening your first pull request — this is a big deal and we appreciate the effort!

While you wait for a review, please double-check:

  • ✅ You've read the CONTRIBUTING.md checklist
  • npm run lint, npm run format, and npm run test all pass locally
  • ✅ Your PR has a visual preview if it touches any SVG output
  • 💬 You've joined our Discord for faster PR feedback

A maintainer will review your PR shortly. Hang tight! 🚀

@github-actions github-actions Bot added the needs-rebase This PR has merge conflicts and needs a rebase. label Jun 3, 2026
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Jun 3, 2026

⚠️ Hey @REHAN-503, this PR has merge conflicts with the main branch.

Please pull the latest changes and resolve the conflicts so we can review it!

git fetch origin
git rebase origin/main
# resolve any conflicts, then:
git push --force-with-lease

Once resolved, the needs-rebase label will be removed automatically on the next check. 🙌

1 similar comment
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Jun 3, 2026

⚠️ Hey @REHAN-503, this PR has merge conflicts with the main branch.

Please pull the latest changes and resolve the conflicts so we can review it!

git fetch origin
git rebase origin/main
# resolve any conflicts, then:
git push --force-with-lease

Once resolved, the needs-rebase label will be removed automatically on the next check. 🙌

@REHAN-503 REHAN-503 force-pushed the docs/query-param-matrix branch 4 times, most recently from df9e0fd to e293995 Compare June 3, 2026 11:18
atul-upadhyay-7 and others added 20 commits June 3, 2026 16:53
…alidation & Schema Constraints Stability (Variation 10)

The StudentProfile model exposes the IEducation, IExperience, and
IStudentProfile interfaces alongside its mongoose schema, but there was
no compiler-level test that pinned those declarations down. Add isolated
expectTypeOf assertions for the public surface and pair them with
runtime validateSync checks so a future refactor that changes a field
type, drops a required validator, or relaxes the graduationYear
constraint gets caught at PR time.
Creates 33 test cases covering massive data sets and extreme high
bounds for the BackgroundRefresh service. Tests include high-volume
isStale processing (100k calls), extreme temporal boundary handling,
concurrent trigger floods with 10k-50k unique usernames, memory
stability under 50k active job tracking, dedup verification with
casing and whitespace variations, and performance bounds for all
major execution paths.
git push origin test-compare-mock-integrations
Mohammedsami001 and others added 25 commits June 3, 2026 16:54
@REHAN-503 REHAN-503 force-pushed the docs/query-param-matrix branch from e293995 to 4a09003 Compare June 3, 2026 11:24
@REHAN-503 REHAN-503 closed this Jun 3, 2026
@REHAN-503 REHAN-503 deleted the docs/query-param-matrix branch June 3, 2026 11:31
@REHAN-503 REHAN-503 restored the docs/query-param-matrix branch June 3, 2026 11:32
@REHAN-503 REHAN-503 deleted the docs/query-param-matrix branch June 3, 2026 11:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

needs-rebase This PR has merge conflicts and needs a rebase.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs(readme): add full query-param matrix with examples and defaults