docs: Add 'rendering_stac_widgets' page to Concepts section

[divyanshub024]

…ntation

Description

Add 'rendering_stac_widgets' page to the Concepts section Docs

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
  • Added a comprehensive guide for rendering Stac widgets, covering four rendering approaches with prerequisites, usage examples, and best practices.
  • Included guidance on network request configuration, hybrid fallbacks, and error/loading widget customization.
  • Updated navigation to include the new Concepts documentation entry and added an icon for the Concepts section.

[coderabbitai]

Walkthrough

Adds a new documentation page describing four methods to render STAC widgets (Stac Cloud, JSON, assets, network) with examples, prerequisites, and guidance. Updates docs navigation to add an icon to the Concepts group and register the new page.

Changes

Cohort / File(s)	Summary
Documentation Page docs/concepts/rendering_stac_widgets.mdx	New documentation describing four STAC widget rendering methods (Stac Cloud, from JSON, from assets, from network), prerequisites, usage examples, properties, setup steps, error/loading customization, hybrid fallback example, and a comparison table.
Navigation Configuration docs/docs.json	Added icon: "book" to the Concepts group and appended concepts/rendering_stac_widgets to the Concepts group's pages array.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

• Verify code examples in docs/concepts/rendering_stac_widgets.mdx are syntactically correct and reflect current APIs.
• Confirm documented StacNetworkRequest and network-related configuration fields match implementation.
• Check docs/docs.json changes correctly integrate with the docs navigation and icon rendering.

Poem

🐰
Four widgets bloom along the trail,
JSON, assets, cloud, and network sail,
Docs lay the crumbs, and guides unfold,
A rabbit hops through methods bold,
Happy hops for changes told! 🥕✨

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 'rendering_stac_widgets' page to Concepts section" directly and specifically describes the main change in the changeset. The title clearly indicates that a new documentation page is being added to the Concepts section and explicitly names the page ('rendering_stac_widgets'), which aligns with the actual changes to both docs/concepts/rendering_stac_widgets.mdx and the navigation configuration in docs/docs.json. The title is concise, uses clear language without vague terms, and provides sufficient specificity that a reviewer scanning the commit history would immediately understand the primary purpose of the change.

✨ 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 18511db and c87a04f.

📒 Files selected for processing (1)

• docs/concepts/rendering_stac_widgets.mdx (1 hunks)

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

• docs/concepts/rendering_stac_widgets.mdx

---

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

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between dc8a145 and 18511db.

📒 Files selected for processing (2)

• docs/concepts/rendering_stac_widgets.mdx (1 hunks)
• docs/docs.json (1 hunks)

🔇 Additional comments (9)

docs/docs.json (1)

36-43: Navigation configuration is solid.

The icon assignment and page registration are properly structured and follow existing patterns in the config.

docs/concepts/rendering_stac_widgets.mdx (8)

1-4: Front matter and title are well-structured.

Clear, descriptive title and description that accurately represent the content.

---

8-20: Prerequisites section is thorough.

Provides essential initialization boilerplate with import paths and async setup pattern that users need before using any rendering method.

---

24-104: Stac Cloud method documentation is comprehensive and well-paced.

The section effectively walks from simple usage (routeName only) through the Dart source workflow, properties reference, practical example with error/loading states, and clear decision criteria. The explanation of how stac deploy converts Dart to JSON uploads to Cloud is pedagogically valuable.

---

105-155: JSON method is concise and appropriate.

The defensive null-coalescing pattern on line 144 (?? const SizedBox()) is a good practice example for production code.

---

156-227: Assets method includes necessary setup guidance.

The pubspec.yaml configuration snippet (lines 182–186) makes the method reproducible. Error handling example on lines 204–215 is thorough and actionable.

---

228-341: Network method is detailed with real-world patterns.

Dual examples (GET with auth headers, POST with body) cover the primary use cases. The StacNetworkRequest properties table is helpful for developers implementing custom API endpoints.

---

342-349: Comparison table is a valuable reference.

Clearly differentiates methods on source, best-for use case, and network dependency—helps readers pick the right approach quickly.

---

358-377: Hybrid approach example is realistic and instructive.

The fallback pattern—checking network connectivity and falling back to offline assets—demonstrates a mature pattern for production resilience. Correct use of FutureBuilder and conditional rendering.