doc(intro): add "Reading Instructions" section

mildronize · May 26, 2024 · 08e9d00 · 08e9d00
1 parent 5947632
commit 08e9d00
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/bun.lockb b/bun.lockb
diff --git a/docs/intro.md b/docs/intro.md
@@ -66,6 +66,21 @@ The book is divided into several sections, each covering a different topic. Each
 - Section 6: Framework Patterns
 - Section 7: Performance
 
+## Reading Instructions
+
+This book contains many code examples, with [twoslash plugin](https://shiki.matsu.io/packages/vitepress#twoslash) you can peak the type definitions by hovering over the code. For example:
+
+```ts twoslash
+type User = {
+  name: string
+  age: number
+}
+
+type UserWithoutAge = Omit<User, 'age'>
+```
+
+I recommend that you try running the code examples in the [TypeScript Playground](https://www.typescriptlang.org/play) or your own editor to get a better understanding of the concepts. However, I you need interactive examples I don't have enough time to support it, feel free to open the Pull Request on [GitHub](https://github.com/mildronize/type-safe-design-pattern) for [adding monao editor](https://github.com/vuejs/vitepress/issues/1508#issuecomment-1689500884) to the page.
+
 ## Recommended Reading
 
 - [Type-Level Programming](https://type-level-typescript.com/) e-book.