Skip to content

Rename Getting Started conclusion to "Before You Build" with key tips#3433

Merged
khadni merged 3 commits intomainfrom
quickjs-compatibility-discovery
Feb 4, 2026
Merged

Rename Getting Started conclusion to "Before You Build" with key tips#3433
khadni merged 3 commits intomainfrom
quickjs-compatibility-discovery

Conversation

@khadni
Copy link
Collaborator

@khadni khadni commented Feb 4, 2026

This pull request updates the "Getting Started" experience for CRE by replacing the old "Conclusion & Next Steps" section with a new, more actionable "Before You Build" guide, tailored for both TypeScript and Go developers. The new guides provide essential tips on deterministic development, library compatibility, and working with Solidity integers, as well as curated next steps and reference resources. The sidebar navigation is updated accordingly, and related documentation is improved for clarity.

Major documentation improvements and restructuring:

  • Added new "Before You Build" guides for both TypeScript (before-you-build-ts.mdx) and Go (before-you-build-go.mdx), providing practical tips on deterministic development, library compatibility, and Solidity integer handling, along with curated next steps and references. [1] [2]
  • Removed the old conclusion.mdx file, consolidating and expanding its content into the new "Before You Build" guides for a more actionable and relevant developer experience.
  • Updated the sidebar configuration in sidebar.ts to replace the "Conclusion & Next Steps" link with the new "Before You Build" entry, and added highlighting for the new TypeScript and Go guides.

Clarity and best practices for Solidity integer handling:

  • Enhanced the caution and example in the "Writing Data Onchain" guide to emphasize always using bigint for Solidity integers in TypeScript, including a clear explanation and code samples to prevent silent precision loss.

@khadni khadni requested a review from a team as a code owner February 4, 2026 15:12
@khadni khadni added the CRE label Feb 4, 2026
@vercel
Copy link

vercel bot commented Feb 4, 2026

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

Project Deployment Actions Updated (UTC)
documentation Ready Ready Preview Feb 4, 2026 5:26pm

Request Review

@github-actions
Copy link
Contributor

github-actions bot commented Feb 4, 2026

👋 khadni, thanks for creating this pull request!

To help reviewers, please consider creating future PRs as drafts first. This allows you to self-review and make any final changes before notifying the team.

Once you're ready, you can mark it as "Ready for review" to request feedback. Thanks!

@khadni khadni enabled auto-merge (squash) February 4, 2026 17:25
@khadni khadni merged commit 4dfcbe9 into main Feb 4, 2026
22 checks passed
@khadni khadni deleted the quickjs-compatibility-discovery branch February 4, 2026 17:26
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