docs: Add custom widget and action documentation.

[divyanshub024]

Description

Add custom widget and action documentation.

Type of Change

• New feature (non-breaking change which adds functionality)
• Bug fix (non-breaking change which fixes an issue)
• Breaking change (fix or feature that would cause existing functionality to change)
• Code refactor
• Build configuration change
• Documentation
• Chore

Summary by CodeRabbit

• Documentation
  • Reorganized concept docs for improved discoverability and clarity
  • Added comprehensive guides for creating and integrating custom actions
  • Added guides for creating and integrating custom widgets with JSON serialization
  • Removed older parser/action-parser concept pages and updated the Concepts navigation to reflect the new pages

[coderabbitai]

Walkthrough

Removed two legacy concept pages and added two new concept guides; updated the docs navigation to reference the new pages. No code or public API changes.

Changes

Cohort / File(s)	Summary
Removed documentation docs/concepts/action_parsers.mdx, docs/concepts/parsers.mdx	Deleted legacy concept pages describing Stac action parsers and Stac parsers.
Added documentation docs/concepts/custom_actions.mdx, docs/concepts/custom_widgets.mdx	Added comprehensive guides for creating and registering custom StacAction and StacWidget implementations, including JSON (de)serialization and parser wiring.
Navigation updates docs/docs.json	Updated Concepts navigation: removed concepts/action_parsers, concepts/parsers, concepts/theming; added concepts/custom_widgets, concepts/custom_actions.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

• Verify docs/docs.json entries match the new file names and paths.
• Check for broken links or references elsewhere in docs to the removed pages.
• Confirm the new guides contain necessary cross-links and formatting.

Possibly related PRs

• docs: Add 'rendering_stac_widgets' page to Concepts section #376 — Modifies docs navigation and concept pages; likely related to the reorganization of Concepts navigation.

Suggested reviewers

• rahulbisht25
• Potatomonsta

Poem

🐰 A nibble here, a hop there, pages turned anew,
Old parsers shelved, fresh guides in view.
Widgets and actions, wrapped in JSON light,
I bounce with joy — the docs feel right! 🥕✨

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	You can run @coderabbitai generate docstrings to improve docstring coverage.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The pull request title "docs: Add custom widget and action documentation." accurately reflects the main changes in the changeset. The summary shows two new documentation files were added: docs/concepts/custom_actions.mdx and docs/concepts/custom_widgets.mdx, which directly correspond to the title's claim. While the PR also includes removals of older documentation files and navigation updates, the primary change and stated objective is to add the new documentation, making those secondary reorganization tasks. The title is concise, clear, and avoids vague terminology, providing a teammate scanning the history with a clear understanding of what was added.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch dv/docs

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between dfa5ff9 and 37e15ca.

📒 Files selected for processing (2)

• docs/concepts/custom_actions.mdx (1 hunks)
• docs/concepts/custom_widgets.mdx (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• docs/concepts/custom_actions.mdx

🧰 Additional context used

🪛 LanguageTool

docs/concepts/custom_widgets.mdx

[grammar] ~226-~226: Ensure spelling is correct
Context: ..... fromJson and toJson } ``` ### Using Stac Types Prefer Stac types over primitive...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

🔇 Additional comments (3)

docs/concepts/custom_widgets.mdx (3)

32-172: Step-by-step guide is clear and well-structured.

The progression from widget class definition → code generation → parser creation → registration is logical and actionable. Code examples for both the widget class and parser implementation are helpful and appear syntactically correct for Dart/Flutter.

---

174-244: Advanced patterns section provides valuable guidance.

The converters (DoubleConverter, StacWidgetConverter) and Stac types recommendations are practical. Using Stac types over primitive types maintains consistency across the framework.

---

272-293: JSON output example is helpful for validation.

The concrete JSON representation showing the serialized custom widget alongside a parent scaffold clearly illustrates the final shape of the data.

---

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: 2

🧹 Nitpick comments (1)

docs/concepts/custom_actions.mdx (1)

180-207: Verify converter documentation completeness.

The DoubleConverter is documented, but line 184 mentions converters are similar to widgets. Ensure this section documents all relevant converters applicable to actions with consistency to the custom_widgets documentation.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ff46e4c and dfa5ff9.

📒 Files selected for processing (5)

• docs/concepts/action_parsers.mdx (0 hunks)
• docs/concepts/custom_actions.mdx (1 hunks)
• docs/concepts/custom_widgets.mdx (1 hunks)
• docs/concepts/parsers.mdx (0 hunks)
• docs/docs.json (1 hunks)

💤 Files with no reviewable changes (2)

• docs/concepts/parsers.mdx
• docs/concepts/action_parsers.mdx

🧰 Additional context used

🪛 LanguageTool

docs/concepts/custom_widgets.mdx

[grammar] ~226-~226: Ensure spelling is correct
Context: ..... fromJson and toJson } ``` ### Using Stac Types Prefer Stac types over primitive...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

🔇 Additional comments (4)

docs/docs.json (1)

36-43: Navigation updates are correctly configured.

The Concepts group now references the new custom widgets and actions documentation. The structure aligns with the new documentation files.

docs/concepts/custom_actions.mdx (1)

36-63: Excellent code examples and clear documentation structure.

The step-by-step guide with accompanying code examples is well-organized and easy to follow. Examples correctly demonstrate class definition, JSON serialization, parser implementation, and usage patterns.

Also applies to: 138-161, 211-250

docs/concepts/custom_widgets.mdx (2)

36-65: Code examples and documentation structure are excellent.

The step-by-step guide with accompanying code examples is comprehensive and well-organized. Examples correctly demonstrate widget class definition, JSON serialization, parser implementation, and usage patterns. The progression from basic to advanced patterns is logical and helpful.

Also applies to: 129-156, 249-293

---

174-245: Advanced patterns and type guidance are well-documented.

The advanced patterns section comprehensively covers both DoubleConverter and StacWidgetConverter with clear examples. The "Using Stac Types" section provides valuable guidance for maintaining consistency and best practices when building custom widgets.