Skip to content

docs(ui): document async-status and react-query export paths - #230

Merged
pjeweb merged 4 commits into
mainfrom
docs/ui-async-status
Aug 27, 2026
Merged

docs(ui): document async-status and react-query export paths#230
pjeweb merged 4 commits into
mainfrom
docs/ui-async-status

Conversation

@pjeweb

@pjeweb pjeweb commented Aug 27, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Restore the @mapsight/ui README export table for async-status and react-query.
  • Add packages/ui/docs/ASYNC_STATUS.md describing the loading/error presentation layer.

@changeset-bot

changeset-bot Bot commented Aug 27, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: ee99bde

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 0 packages

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Updates @mapsight/ui documentation to clarify async-status / loading presentation layering and to restore/expand the README export-path table for async-status and react-query helpers.

Changes:

  • Restore and expand packages/ui/README.md export table entries for async-status and react-query, including peer-dependency notes.
  • Add packages/ui/docs/ASYNC_STATUS.md documenting the async-status architecture, adapters, and TanStack Query alignment.
  • Add a Changesets entry (currently empty).

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File Description
packages/ui/README.md Restores/extends export-path table + links to async-status architecture doc.
packages/ui/docs/ASYNC_STATUS.md Adds detailed documentation for async-status layering, view model, and display rules.
.changeset/ui-async-status-docs.md Adds a changeset file (currently missing required content).

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread .changeset/ui-async-status-docs.md
@pjeweb
pjeweb merged commit 1a44f47 into main Aug 27, 2026
21 checks passed
@pjeweb
pjeweb deleted the docs/ui-async-status branch August 27, 2026 22:23
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.

2 participants