Skip to content

Update dataset snapshots documentation#48

Open
spinningrachel wants to merge 9 commits intomainfrom
docs/gap-analysis-new-features
Open

Update dataset snapshots documentation#48
spinningrachel wants to merge 9 commits intomainfrom
docs/gap-analysis-new-features

Conversation

@spinningrachel
Copy link
Copy Markdown
Collaborator

Summary

  • Add Editor/Owner role requirement and operations-blocked warning callouts
  • Document automatic revision creation before pipeline operations
  • Add failure behavior details for snapshot creation
  • Add Navigating Between Versions section
  • Replace all placeholder screenshots with actual UI captures
  • Add screenshots for snapshot options menu, edit dialog, and remove confirmation

Test plan

  • Verify page renders correctly with mintlify dev
  • Confirm all screenshot images load properly
  • Check that new sections follow existing page structure and style

🤖 Generated with Claude Code

spinningrachel and others added 2 commits March 31, 2026 19:44
… and real screenshots

Add Editor/Owner role requirement note, automatic revision detail for pipeline
operations, failure behavior on creation, Navigating Between Versions section,
and replace all placeholder screenshots with actual UI captures.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Add Pending/Initializing/Aborted status descriptions, dedicated Task Types
table, expanded filter reference table, and duration detail for pending tasks.
Expand task concurrency table with specific blocked operations. Exclude
Camtek-specific manufacturing metadata columns (Job, Setup, Recipe).

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
spinningrachel and others added 2 commits March 31, 2026 20:12
Rewrite notifications.mdx as full Monitoring and Alerts documentation
covering how monitoring works, trend data, alert enabling/disabling,
alert panel, badge, delivery to all dataset collaborators, and
monitoring without alerts. Simplify the Monitoring section in saved
views to a summary with cross-reference to the dedicated page.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Use <Steps> for the explanatory how-it-works flow, keeping procedural
actions as ordered lists per documentation conventions.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Replace generic expanded view image with saved-views-monitoring-trenddata.png
showing actual trend bar chart and result preview.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
…notifications

Expand saved-views.mdx with trend data and alerting endpoints, tested
against live API. Create new notifications.mdx covering list, unread
count, mark-as-read, mark-all-read, and SSE streaming endpoints. All
examples use verified request/response pairs. Add notifications page
to docs.json navigation.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Cross-reference saved views, notifications API, and monitoring docs
from the add media page since adding media triggers view evaluation.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Replace "dataset's history" and "dataset's enrichment panel" with
non-possessive alternatives per style guidelines.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
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.

1 participant