Skip to content

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

@JhaSourav07

Description

@JhaSourav07

🧩 Background

Parameter usage is discoverable but spread across sections, making onboarding harder for new users.

🎯 Objective

Add a single query-parameter matrix in README with defaults, allowed values, and examples.

📁 Files to check

  • README.md
  • THEMES.md

🛠️ Implementation steps

  • Document each supported query parameter.
  • Include defaults, constraints, and one practical example per parameter.
  • Cross-link related sections and keep naming consistent.

✅ Definition of done

  • README contains a complete, easy-to-scan parameter table.
  • Examples are copy-paste friendly.
  • Docs stay consistent with current API behavior.

Metadata

Metadata

Labels

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions