Skip to content

Update block documentation#7

Open
thomaskimura wants to merge 1 commit intomainfrom
tembo/document-update-blocks-help-docs
Open

Update block documentation#7
thomaskimura wants to merge 1 commit intomainfrom
tembo/document-update-blocks-help-docs

Conversation

@thomaskimura
Copy link
Member

@thomaskimura thomaskimura commented Feb 26, 2026

Summary

Updated and standardized documentation for all blocks in the slab/blocks/ directory:

  • Revised 30+ existing block documentation files with consistent formatting, updated settings tables, and improved descriptions
  • Added 7 new block documentation files for previously undocumented blocks:
    • _g__cart-progress-tier.md
    • _g__map-item.md
    • cart-count.md
    • cart-discount.md
    • cart-fulltotals.md
    • cart-notes.md
    • cart-price.md
    • cart-results.md
    • cart-share.md
    • cart-summary.md
    • checkbox-upsell.md
    • checkout-approval.md
    • checkout.md
    • container.md
    • error.md
    • form-response.md
    • input-field.md
    • map.md
    • progress-bar.md
    • shop-pay-installments.md
  • Standardized all settings tables with consistent column headers and formatting
  • Updated color scheme options across all blocks to use new Type, Scheme, and Enable inheritance pattern
  • Improved "Common use cases" sections with more actionable guidance
  • Added "Block limitations" sections to private blocks explaining their usage constraints
  • Replaced outdated option formatting (e.g., • None (default)) with consistent bullet point style (• None (default))
  • Updated visibility options from "All/Mobile only/Desktop only" to "Show on all devices/Show on mobile only/Show on desktop only"
  • Added generate_docs.py script for automated documentation generation from block schema files

Related Pull Requests


Want tembo to make any changes? Add a review or comment with @tembo and i'll get back to work!

View on Tembo View Agent Settings

…d content

Co-authored-by: Thomas <thomas@brickspacelab.com>
@tembo tembo bot added the tembo Pull request created by Tembo label Feb 26, 2026
@tembo tembo bot requested a review from rtr1111 February 26, 2026 23:17
@tembo
Copy link

tembo bot commented Feb 26, 2026

Requesting review from @rtr1111 who has experience with the following files modified in this PR:

  • slab/blocks/icon.md
  • slab/blocks/logo.md
  • slab/blocks/menu.md
  • slab/blocks/_tags.md
  • slab/blocks/error.md
  • slab/blocks/image.md
  • slab/blocks/share.md
  • slab/blocks/video.md
  • slab/blocks/button.md
  • slab/blocks/filter.md
  • slab/blocks/liquid.md
  • slab/blocks/avatars.md
  • slab/blocks/hotspot.md
  • slab/blocks/dropdown.md
  • slab/blocks/richtext.md
  • slab/blocks/accordion.md
  • slab/blocks/menu-page.md
  • slab/blocks/shop-login.md
  • slab/blocks/visibility.md
  • slab/blocks/_pagination.md
  • slab/blocks/filter-tags.md
  • slab/blocks/input-field.md
  • slab/blocks/layout__tab.md
  • slab/blocks/product-buy.md
  • slab/blocks/_g__tab-item.md
  • slab/blocks/_grid-recent.md
  • slab/blocks/article-card.md
  • slab/blocks/contact-form.md
  • slab/blocks/layout__flex.md
  • slab/blocks/layout__grid.md
  • slab/blocks/picker-audio.md
  • slab/blocks/search-input.md
  • slab/blocks/social-icons.md
  • slab/blocks/_avatar-image.md
  • slab/blocks/_g__flex-item.md
  • slab/blocks/_g__grid-item.md
  • slab/blocks/_g__menu-item.md
  • slab/blocks/_g__table-row.md
  • slab/blocks/_grid-gallery.md
  • slab/blocks/_layout__blog.md
  • slab/blocks/form-response.md
  • slab/blocks/layout__float.md
  • slab/blocks/layout__table.md
  • slab/blocks/menu-dropdown.md
  • slab/blocks/password-form.md
  • slab/blocks/payment-icons.md
  • slab/blocks/product-media.md
  • slab/blocks/product-price.md
  • slab/blocks/_g__table-cell.md
  • slab/blocks/_grid-articles.md
  • slab/blocks/_grid-products.md
  • slab/blocks/_slider-recent.md
  • slab/blocks/layout__inline.md
  • slab/blocks/layout__slider.md
  • slab/blocks/overlay__alert.md
  • slab/blocks/overlay__popup.md
  • slab/blocks/picker-country.md
  • slab/blocks/product-badges.md
  • slab/blocks/product-pickup.md
  • slab/blocks/product-rating.md
  • slab/blocks/search-results.md
  • slab/blocks/search-summary.md
  • slab/blocks/_g__slider-item.md
  • slab/blocks/_layout__search.md
  • slab/blocks/_slider-gallery.md
  • slab/blocks/layout__marquee.md
  • slab/blocks/layout__overlay.md
  • slab/blocks/newsletter-form.md
  • slab/blocks/overlay__drawer.md
  • slab/blocks/picker-language.md
  • slab/blocks/product-bundles.md
  • slab/blocks/product-options.md
  • slab/blocks/shared-discount.md
  • slab/blocks/_g__hotspot-spot.md
  • slab/blocks/_slider-articles.md
  • slab/blocks/_slider-products.md
  • slab/blocks/image-comparison.md
  • slab/blocks/overlay__sidebar.md
  • slab/blocks/product-swatches.md
  • slab/blocks/render-quick-buy.md
  • slab/blocks/_grid-collections.md
  • slab/blocks/product-inventory.md
  • slab/blocks/product-quick-buy.md
  • slab/blocks/render-quick-edit.md
  • slab/blocks/localization-label.md
  • slab/blocks/_layout__collection.md
  • slab/blocks/_slider-collections.md
  • slab/blocks/product-subscription.md
  • slab/blocks/_g__grid-paginateitem.md
  • slab/blocks/_grid-recommendations.md
  • slab/blocks/age-verification-form.md
  • slab/blocks/_slider-recommendations.md
  • slab/blocks/product-sibling-options.md
  • slab/blocks/_layout__list-collections.md

Copy link

@cursor cursor bot left a comment

Choose a reason for hiding this comment

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

Cursor Bugbot has reviewed your changes and found 1 potential issue.

Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.


container__checkout.liquid


Copy link

Choose a reason for hiding this comment

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

Checkout block overview is placeholder text

High Severity

The Overview section of checkout.md contains the internal filename container__checkout.liquid instead of a proper description of the checkout block. This looks like placeholder or scaffolding text that was left in by mistake.

Fix in Cursor Fix in Web

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

tembo Pull request created by Tembo

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant