โ† Back to Roadmap

Content Preview

13 features

๐Ÿ“‹ Description

A unified, read-only preview experience that lets authors quickly validate structure, resolved references, and conditional content without leaving the authoring context. It standardizes how content renders across object types (XML, recipes, graphics, structured text), adds profiling visualization and filters to simulate targeted delivery, and captures lightweight telemetry for operational insight.

๐Ÿ’Ž Business Value

Faster reviews, fewer publishing errors, and greater confidence in content qualityโ€”without introducing branding or editing complexity.

๐Ÿ—บ๏ธ Roadmap Features (8)

Generic unified preview

A consistent, neutral-styled preview for all supported object types to validate structure and substance quickly, reducing early publish errors and review time.

Inline XML reference resolution

Expands graphics, inclusions, so authors review fully assembled content without time-consuming manual navigation.

Link navigation with history

Enables in-preview traversal across linked objects with back/forward history and preserved scroll positions to streamline interconnected content review.

Profiling filter

Applies attribute-based filters to simulate targeted delivery, hiding non-matching content while keeping the preview responsive and stateful.

Profiling highlight & inspection

Visualizes profiled elements and exposes their attributes (e.g., audience, product, version) to prevent mis-profiled content from reaching publication.

Recipe hierarchy visualization

Renders recipe objects as an intuitive tree of sections and ingredients with navigable nodes, improving structural comprehension at a glance.

Standalone graphic preview

Shows images (PNG/JPG/SVG) without surrounding metadata or chrome, focusing author attention on asset correctness and sizing behavior.

SVG pan & zoom

Interactive pan/zoom/reset for SVGs to inspect complex diagrams efficiently, maintaining smooth responsiveness for typical assets.

โœ“ Merged to main
๐Ÿ• Development time: 0d-00h-48mโฑ Time to deployment: 0d-00h-02m

๐Ÿ“‹ Development Summary

Summary: This work introduced transitional recipe preview support as part of the Content Preview epic and completed the merge to main. The changes also included regenerating documentation index files to resolve generated-file conflicts and keep project documentation aligned with the new functionality. Key Changes: - Added transitional recipe preview support to enable content preview capabilities for recipes. - Merged PR 244 into main, integrating the new preview-related functionality into the primary codebase. - Regenerated documentation index files to reflect the latest changes. - Resolved documentation index conflicts by rebuilding generated docs artifacts. Impact: These changes advance the Content Preview initiative by adding recipe preview support while ensuring the codebase remains stable and documentation stays consistent. This improves developer reliability during integration and helps teams adopt the new preview functionality with fewer merge and documentation issues.

๐Ÿ”ง API Changes (5 files)

  • M src/Aleido.Platform.API/Endpoints/RecipeEndpoints.cs
  • M src/Aleido.Platform.API/Extensions/ServiceRegistrationExtensions.cs
  • A src/Aleido.Platform.API/Models/Preview/RecipePreviewResponse.cs
  • A src/Aleido.Platform.API/Services/Recipe/IRecipePreviewService.cs
  • A src/Aleido.Platform.API/Services/Recipe/RecipePreviewService.cs

๐Ÿ“ Commit Log

aecd38562 Resolve docs index conflicts by regenerating generated files 4ae5af371 Regenerate documentation index c107244b2 Add transitional recipe preview support

๐Ÿ’ป Development Features (5)

Inline Profile Highlights Toggle

No description available

Preview Telemetry Events

No description available

Preview Filter Summary Integration

No description available

Build, Test, and Documentation Verification

No description available

Profile Legend Aggregation and Endpoint

No description available