Skip to content

docs: add conceptual documentation for Stac Registry#473

Merged
divyanshub024 merged 5 commits intoStacDev:devfrom
Shonu72:dev
Apr 17, 2026
Merged

docs: add conceptual documentation for Stac Registry#473
divyanshub024 merged 5 commits intoStacDev:devfrom
Shonu72:dev

Conversation

@Shonu72
Copy link
Copy Markdown
Contributor

@Shonu72 Shonu72 commented Apr 7, 2026

Description

This PR adds comprehensive conceptual documentation for the Stac Registry, addressing the lack of clear explanation for this core component.

Key changes include:

  • New Concept Page: Created docs/concepts/stac_registry.mdx which explains what the Registry is, why it's used, and how it manages widget/action parsers and global state.
  • Architectural Visualization: Added a Mermaid diagram and a step-by-step data flow guide to illustrate how the Registry fits into the Stac rendering pipeline.
  • Navigation Update: Registered the new document in docs/docs.json under the "Concepts" navigation group.
  • Usage Examples: Included practical code snippets for custom parser registration and global variable usage.
  • Advanced Tips: Added guidance on recursive variable resolution, parser overrides, and memory management (singleton lifecycle).

Related Issues

Closes #409

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

@CLAassistant
Copy link
Copy Markdown

CLAassistant commented Apr 7, 2026

CLA assistant check
All committers have signed the CLA.

@divyanshub024
Copy link
Copy Markdown
Member

@coderabbitai review.

@divyanshub024
Copy link
Copy Markdown
Member

Hey @Shonu72, can you please fix the formatting issue?

Comment on lines +82 to +86
```dart
StacRegistry.instance.register(
const MyBrandedTextParser(),
override: true, // This replaces the core "text" parser
);
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

StacRegistry.register is declared as a positional optional second parameter, not a named parameter.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Shonu72, can you please check this comment?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the catch! I've updated the sample code in stac_registry.mdx to correctly use a positional parameter for the override flag, matching the actual implementation of StacRegistry.register

@Shonu72
Copy link
Copy Markdown
Contributor Author

Shonu72 commented Apr 13, 2026

Hey @Shonu72, can you please fix the formatting issue?

The CI failure appears to still be related to formatting differences, even after aligning my local Flutter version with CI (3.41.6), cleaning the workspace, and regenerating dependencies.

I’ve ensured that all lockfiles are updated and committed, but the formatting check is still failing in CI.

If this continues to be an issue, we might consider excluding example pubspec.lock files from formatting checks or standardizing the Flutter version across contributors to avoid similar CI failures.

@divyanshub024 divyanshub024 merged commit 40b1428 into StacDev:dev Apr 17, 2026
3 of 4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: Add documentation for Stac Registry

3 participants