Skip to content

feat(tutorials): add a getting-started/quickstart page - #53

Merged
hhimanshu merged 1 commit into
mainfrom
feat/51-getting-started-page
Jul 23, 2026
Merged

feat(tutorials): add a getting-started/quickstart page#53
hhimanshu merged 1 commit into
mainfrom
feat/51-getting-started-page

Conversation

@hhimanshu

@hhimanshu hhimanshu commented Jul 22, 2026

Copy link
Copy Markdown
Contributor

Summary

Adds a self-contained "Getting started" tutorial page: install @truecalc/core, run one SUM(A1, B1) example, and pointers to Tutorials / Learn / Reference. Linked from the homepage and made the first step of the beginner path, so a new visitor can go from zero to a running formula in under a minute instead of clicking through several pages first.

Closes #51

How to test

From the repo root:

npm run dev

Visit http://localhost:3000/tutorials/getting-started and confirm:

  • The install snippet and the SUM(A1, B1) example render correctly.
  • The "Where next" links to /tutorials, /tutorials/your-first-formula, /learn, and /reference all resolve.
  • The homepage (/) and /paths/beginner now link to the new page as the first step.

Or check the executable example directly:

npm run test-docs

which runs the page's ts test block (SUM(A1, B1) against {A1: 100, B1: 200}300) along with every other Learn/Tutorial example.

Review

Independent review: clean. No must-fix findings. Diff touches exactly the 4 in-scope files (new content/docs/tutorials/getting-started.mdx, plus content/docs/index.mdx, content/docs/paths/beginner.mdx, content/docs/tutorials/meta.json); no generated-reference or fixture files touched.

Test plan

  • npm run test-docs — 67/67 blocks passed, including the new page's example
  • npm run build — static export succeeds; new page and all its outbound links resolve in the export
  • npm run lint:enrichment — passes
  • npm run types:check — passes

View with Codesmith Autofix with Codesmith
Need help on this PR? Tag /codesmith with what you need. Autofix is disabled.

Adds a self-contained page (install + one runnable SUM(A1, B1) example,
matching the truecalc-core README for consistency) so a visitor can go
from zero to a running formula in under a minute, instead of clicking
through several pages first. Linked from the homepage and made the
first step of the beginner path.

closes #51
@hhimanshu hhimanshu self-assigned this Jul 22, 2026
@hhimanshu
hhimanshu merged commit 36b0e2d into main Jul 23, 2026
1 check passed
@hhimanshu
hhimanshu deleted the feat/51-getting-started-page branch July 23, 2026 00:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

feat: add a getting-started / quickstart page

1 participant