docs: restructure dataset schema page with introduction and guidance#2554
Open
jancurn wants to merge 6 commits into
Open
docs: restructure dataset schema page with introduction and guidance#2554jancurn wants to merge 6 commits into
jancurn wants to merge 6 commits into
Conversation
Adds a comprehensive "Why use views" section to dataset schema docs that explains the purpose and benefits of views, when to use them, how to organize views by use case, and what views are NOT for. Also includes a practical multi-view example for an e-commerce scraper. This addresses feedback that the documentation explained HOW to configure views but not WHY or WHEN to use them. Slack thread: https://apify.slack.com/archives/C010Q0FBYG3/p1779357816377359?thread_ts=1779115904.940779&cid=C010Q0FBYG3 https://claude.ai/code/session_01JyTmwWUsZaN7436BBgxwvG
Contributor
|
✅ Preview for this PR (commit |
- Shorten the why/when content significantly - Add link to Google Maps Scraper as real-world example - Keep the anti-pattern note (useful guidance) - Remove redundant explanations https://claude.ai/code/session_018Upw3aA9syy5Jm84F1xp9f
Adds clarification that views only affect Console UI display, not how data is exported to JSON, CSV, or other formats. https://claude.ai/code/session_01JyTmwWUsZaN7436BBgxwvG
Reorganizes the page to provide better context before diving into details: - Adds introduction explaining what dataset schema is and its two components - Moves file structure section before examples - Reorganizes into clear Fields and Views sections as parallel concepts - Consolidates reference tables at the end - Maintains all existing content but in a more logical flow The page now follows the same pattern as other actor definition pages (input_schema, output_schema) where concepts are introduced before examples. https://claude.ai/code/session_01JyTmwWUsZaN7436BBgxwvG
jancurn
changed the title
jancurn
changed the title
jancurn
commented
May 21, 2026
| } | ||
| } | ||
| } | ||
| "fields": { /* JSON Schema describing each item */ }, |
Member
Author
There was a problem hiding this comment.
Instead of these comments, keep there the short examples
Addresses review feedback to show actual field/view examples instead of comments in the schema components overview. https://claude.ai/code/session_01JyTmwWUsZaN7436BBgxwvG
jancurn
changed the title
jancurn
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Restructures the dataset schema documentation to provide proper context before diving into details:
fieldsandviews)The page now follows the same pattern as other actor definition pages (input_schema, output_schema).
Context
Based on feedback from Martin Sabo and Jaroslav Hejlek in #dev-docs - the documentation explained HOW to configure views but not WHY or WHEN to use them.
Slack thread: https://apify.slack.com/archives/C010Q0FBYG3/p1779357816377359?thread_ts=1779115904.940779&cid=C010Q0FBYG3
Test plan
https://claude.ai/code/session_01JyTmwWUsZaN7436BBgxwvG