Skip to content

docs: refresh README and add playground screenshot - #164

Merged
mkayander merged 3 commits into
mainfrom
cursor/readme-improvements-eebb
Aug 9, 2026
Merged

docs: refresh README and add playground screenshot#164
mkayander merged 3 commits into
mainfrom
cursor/readme-improvements-eebb

Conversation

@mkayander

@mkayander mkayander commented Aug 9, 2026

Copy link
Copy Markdown
Owner

Summary

Updates the project README to be clearer and more welcoming for newcomers, and replaces the old external Imgur screenshot with a fresh local capture of the playground.

Changes

  • New tagline and structure — leads with what dStruct does and why it matters, not a list of libraries
  • Fresh screenshotdocs/images/playground-screenshot.png (Tree Traversal problem with editor + visualization), stored as a valid PNG
  • Accurate stack info — PostgreSQL, MUI v9, Vitest, tRPC, Pyodide; removed outdated Express/SQLite/Jest references
  • Reproducible quick start — repository-pinned pnpm via Corepack, Docker-based PostgreSQL setup, schema application, and sample-data loading
  • Cleaner reference sections — env vars table, scripts table, contributing/license links
  • Correct links and formatting — fixed the license target and formatted Markdown with the project Prettier config

Validation

  • Captured the screenshot from the local dev server at /playground/tree-traversal after the page fully loaded
  • Verified all local README link targets exist
  • Verified the image is a 1280×800 PNG
  • README passes Prettier and git diff --check
  • pnpm lint passes (existing warnings only)
  • 85 Vitest files / 432 tests pass
  • 27 Python harness tests pass
Open in Web Open in Cursor 

- Rewrite README for newcomers with clearer value prop and quick start
- Fix outdated stack details (PostgreSQL, Vitest, tRPC, no Express/SQLite)
- Add local playground screenshot under docs/images/
- Link to AGENTS.md and .cursorrules for deeper dev setup
@vercel

vercel Bot commented Aug 9, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
dstruct Ready Ready Preview Aug 9, 2026 8:23pm

@mkayander
mkayander marked this pull request as ready for review August 9, 2026 20:24
@cursor

cursor Bot commented Aug 9, 2026

Copy link
Copy Markdown

Bugbot is not enabled for your account, so this pull request was not reviewed.

Enable Bugbot in the Cursor dashboard to get automatic reviews on future PRs.

@mkayander
mkayander merged commit 8f8e300 into main Aug 9, 2026
6 checks passed
@github-actions

github-actions Bot commented Aug 9, 2026

Copy link
Copy Markdown

🎉 This PR is included in version 1.380.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

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

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants