guide icon indicating copy to clipboard operation
guide copied to clipboard

feat/typescript: add TypeScript examples to the guide

Open omar-sobhy opened this issue 1 year ago • 2 comments

Please describe the changes this PR makes and why it should be merged:

WIP WIP! I'm only opening the PR to get opinions on the current structure and suggestions on how to improve things. The current examples are slightly opinionated, but could possibly stand to be more opinionated on things like the tsconfig.json.

This PR adds TypeScript examples to the guide.

Pages now have TypeScript markdown containers when TypeScript-specific tips need to be displayed. Additionally, TypeScript examples are added to pages using code groups so that guide readers can switch between JS/TS examples on the fly.

Closes #1121

omar-sobhy avatar May 07 '24 08:05 omar-sobhy

Something I was considering is creating an entirely separate TypeScript section in the guide and adding all the guide content there. This has the advantage of keeping the JS portion of the guide clean, but it also essentially duplicates the content

omar-sobhy avatar May 07 '24 08:05 omar-sobhy

Maybe eslint section should also include basic information about typescript-eslint too.

ghost avatar May 25 '24 16:05 ghost