docs(readme): expand README for Live Preview, Timeline, Visual Editor, Studio (VB-665) by hiteshshetty-dev · Pull Request #575 · contentstack/live-preview-sdk

hiteshshetty-dev · 2026-03-30T12:36:55Z

Summary

Updates the package README so integrators can see where the SDK runs, how to install and call init, and where to read full config and official docs.

Changes

Badges (npm, MIT), clearer product description, and editor-facing doc links (Live Preview, Timeline, Visual Editor).
Sections for Live Preview, Timeline, Visual Builder, and Composable Studio; integrator note on iframe vs independent.
Requirements (browser-only init, SSR vs CSR pointers to docs/live-preview-configs.md).
Installation, CDN snippet with pinned version, quick start with async init.
Configuration index linking into docs/live-preview-configs.md.
Documentation and learning: developer setup links, content manager links, Studio, and Academy (including Understanding Timeline).
Note on PURGE_PREVIEW_SDK / REACT_APP_PURGE_PREVIEW_SDK for production builds.

Testing

Documentation only; no code paths changed.

…tor, Studio (VB-665) - Add npm and license badges, async init quick start, config index links - Document Live Preview, Timeline, Visual Builder, and Composable Studio contexts - Link canonical Contentstack docs, Academy (including Understanding Timeline), and Studio Made-with: Cursor

github-actions · 2026-03-30T12:37:29Z

🔒 Security Scan Results

ℹ️ Note: Only vulnerabilities with available fixes (upgrades or patches) are counted toward thresholds.

Check Type	Threshold	Result
🔴 Critical Severity	10	✅ Passed
🟠 High Severity	25	✅ Passed
🟡 Medium Severity	500	✅ Passed
🔵 Low Severity	1000	✅ Passed

⏱️ SLA Breach Summary

✅ No SLA breaches detected. All vulnerabilities are within acceptable time thresholds.

Severity	SLA Threshold (with/no fixes)	Status
🔴 Critical	15 / 30 days	✅ Passed
🟠 High	30 / 120 days	✅ Passed
🟡 Medium	90 / 365 days	✅ Passed
🔵 Low	180 / 365 days	✅ Passed

✅ BUILD PASSED - All security checks passed

github-actions · 2026-03-30T12:45:52Z

Coverage Report

Status	Category	Percentage	Covered / Total
🔵	Lines	72.07%	8248 / 11443
🔵	Statements	72.07%	8248 / 11443
🔵	Functions	74.82%	327 / 437
🔵	Branches	85.8%	1257 / 1465

File Coverage

No changed files found.

Generated in workflow #781 for commit 59c2349 by the Vitest Coverage Report Action

- Expand main.mustache to match README (badges, contexts, docs links, Academy) - Use {{packageVersion}} in CDN snippet; pin wording matches README - Remove unused currentYear from mustache.ts DATA Made-with: Cursor

github-actions · 2026-03-30T13:13:18Z

🔒 Security Scan Results

ℹ️ Note: Only vulnerabilities with available fixes (upgrades or patches) are counted toward thresholds.

Check Type	Threshold	Result
🔴 Critical Severity	10	✅ Passed
🟠 High Severity	25	✅ Passed
🟡 Medium Severity	500	✅ Passed
🔵 Low Severity	1000	✅ Passed

⏱️ SLA Breach Summary

✅ No SLA breaches detected. All vulnerabilities are within acceptable time thresholds.

Severity	SLA Threshold (with/no fixes)	Status
🔴 Critical	15 / 30 days	✅ Passed
🟠 High	30 / 120 days	✅ Passed
🟡 Medium	90 / 365 days	✅ Passed
🔵 Low	180 / 365 days	✅ Passed

✅ BUILD PASSED - All security checks passed

Made-with: Cursor

…ache

github-actions · 2026-03-31T05:12:02Z

🔒 Security Scan Results

ℹ️ Note: Only vulnerabilities with available fixes (upgrades or patches) are counted toward thresholds.

Check Type	Threshold	Result
🔴 Critical Severity	10	✅ Passed
🟠 High Severity	25	✅ Passed
🟡 Medium Severity	500	✅ Passed
🔵 Low Severity	1000	✅ Passed

⏱️ SLA Breach Summary

✅ No SLA breaches detected. All vulnerabilities are within acceptable time thresholds.

Severity	SLA Threshold (with/no fixes)	Status
🔴 Critical	15 / 30 days	✅ Passed
🟠 High	30 / 120 days	✅ Passed
🟡 Medium	90 / 365 days	✅ Passed
🔵 Low	180 / 365 days	✅ Passed

✅ BUILD PASSED - All security checks passed

github-actions · 2026-03-31T12:43:13Z

🔒 Security Scan Results

ℹ️ Note: Only vulnerabilities with available fixes (upgrades or patches) are counted toward thresholds.

Check Type	Threshold	Result
🔴 Critical Severity	10	✅ Passed
🟠 High Severity	25	✅ Passed
🟡 Medium Severity	500	✅ Passed
🔵 Low Severity	1000	✅ Passed

⏱️ SLA Breach Summary

✅ No SLA breaches detected. All vulnerabilities are within acceptable time thresholds.

Severity	SLA Threshold (with/no fixes)	Status
🔴 Critical	15 / 30 days	✅ Passed
🟠 High	30 / 120 days	✅ Passed
🟡 Medium	90 / 365 days	✅ Passed
🔵 Low	180 / 365 days	✅ Passed

✅ BUILD PASSED - All security checks passed

…ove Promise usage

github-actions · 2026-03-31T12:53:06Z

🔒 Security Scan Results

ℹ️ Note: Only vulnerabilities with available fixes (upgrades or patches) are counted toward thresholds.

Check Type	Threshold	Result
🔴 Critical Severity	10	✅ Passed
🟠 High Severity	25	✅ Passed
🟡 Medium Severity	500	✅ Passed
🔵 Low Severity	1000	✅ Passed

⏱️ SLA Breach Summary

✅ No SLA breaches detected. All vulnerabilities are within acceptable time thresholds.

Severity	SLA Threshold (with/no fixes)	Status
🔴 Critical	15 / 30 days	✅ Passed
🟠 High	30 / 120 days	✅ Passed
🟡 Medium	90 / 365 days	✅ Passed
🔵 Low	180 / 365 days	✅ Passed

✅ BUILD PASSED - All security checks passed

kirtesh-cstk

LGTM

…for clarity and consistency

github-actions · 2026-04-01T06:49:40Z

🔒 Security Scan Results

ℹ️ Note: Only vulnerabilities with available fixes (upgrades or patches) are counted toward thresholds.

Check Type	Threshold	Result
🔴 Critical Severity	10	✅ Passed
🟠 High Severity	25	✅ Passed
🟡 Medium Severity	500	✅ Passed
🔵 Low Severity	1000	✅ Passed

⏱️ SLA Breach Summary

✅ No SLA breaches detected. All vulnerabilities are within acceptable time thresholds.

Severity	SLA Threshold (with/no fixes)	Status
🔴 Critical	15 / 30 days	✅ Passed
🟠 High	30 / 120 days	✅ Passed
🟡 Medium	90 / 365 days	✅ Passed
🔵 Low	180 / 365 days	✅ Passed

✅ BUILD PASSED - All security checks passed

hiteshshetty-dev requested review from a team as code owners March 30, 2026 12:36

hiteshshetty-dev added 2 commits March 30, 2026 18:30

docs(readme): update terminology from Visual Builder to Visual Editor

de2e43e

docs(mustache): sync README template with published README

6e1572f

- Expand main.mustache to match README (badges, contexts, docs links, Academy) - Use {{packageVersion}} in CDN snippet; pin wording matches README - Remove unused currentYear from mustache.ts DATA Made-with: Cursor

hiteshshetty-dev added 2 commits March 30, 2026 18:58

docs(readme): rename Composable Studio bullet to Studio

82f8791

Made-with: Cursor

docs: update Timeline and Studio descriptions in README and main.must…

52baa79

…ache

kirtesh-cstk reviewed Mar 31, 2026

View reviewed changes

Comment thread README.md Outdated

kirtesh-cstk reviewed Mar 31, 2026

View reviewed changes

Comment thread README.md Outdated

docs: update README and main.mustache to include Studio in descriptions

e8d6ba3

docs: update initialization method in README and main.mustache to rem…

f0b1211

…ove Promise usage

kirtesh-cstk approved these changes Mar 31, 2026

View reviewed changes

docs: enhance descriptions and structure in README and main.mustache …

59c2349

…for clarity and consistency

hiteshshetty-dev merged commit 018e200 into develop_v4 Apr 1, 2026
9 checks passed

hiteshshetty-dev deleted the docs/VB-665-readme branch April 1, 2026 06:58

karancs06 mentioned this pull request Apr 2, 2026

v4.4.0 #578

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs(readme): expand README for Live Preview, Timeline, Visual Editor, Studio (VB-665)#575

docs(readme): expand README for Live Preview, Timeline, Visual Editor, Studio (VB-665)#575
hiteshshetty-dev merged 8 commits intodevelop_v4from
docs/VB-665-readme

hiteshshetty-dev commented Mar 30, 2026 •

edited

Loading

Uh oh!

github-actions bot commented Mar 30, 2026

Uh oh!

github-actions bot commented Mar 30, 2026 •

edited

Loading

Uh oh!

github-actions bot commented Mar 30, 2026

Uh oh!

github-actions bot commented Mar 31, 2026

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Mar 31, 2026

Uh oh!

github-actions bot commented Mar 31, 2026

Uh oh!

kirtesh-cstk left a comment

Uh oh!

github-actions bot commented Apr 1, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

hiteshshetty-dev commented Mar 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Changes

Testing

Uh oh!

github-actions bot commented Mar 30, 2026

🔒 Security Scan Results

⏱️ SLA Breach Summary

Uh oh!

github-actions bot commented Mar 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Coverage Report

Uh oh!

github-actions bot commented Mar 30, 2026

🔒 Security Scan Results

⏱️ SLA Breach Summary

Uh oh!

github-actions bot commented Mar 31, 2026

🔒 Security Scan Results

⏱️ SLA Breach Summary

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Mar 31, 2026

🔒 Security Scan Results

⏱️ SLA Breach Summary

Uh oh!

github-actions bot commented Mar 31, 2026

🔒 Security Scan Results

⏱️ SLA Breach Summary

Uh oh!

kirtesh-cstk left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Apr 1, 2026

🔒 Security Scan Results

⏱️ SLA Breach Summary

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

hiteshshetty-dev commented Mar 30, 2026 •

edited

Loading

github-actions bot commented Mar 30, 2026 •

edited

Loading