Skip to content

Commit b6b6b5c

Browse files
author
Mat Dudek
committed
📝 docs: add complex-types section
1 parent 78c89fe commit b6b6b5c

File tree

3 files changed

+28
-2
lines changed

3 files changed

+28
-2
lines changed

docs/.vitepress/config.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,9 @@ export default defineConfig({
1818
{ text: "Entity", link: "/api/entity" },
1919
{ text: "Observatory", link: "/api/observatory" },
2020
],
21+
"/complex-types": [
22+
{ text: "Methods", link: "/complex-types/methods" },
23+
]
2124
},
2225

2326
socialLinks: [

docs/complex-types/index.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Deep Dive into Complex type within lib
2+
3+
## Exploring Complex TypeScript Types
4+
5+
Welcome to the section where we unravel the intricacies of TypeScript types within our library. As we navigate through the TypeScript landscape, you'll encounter some sophisticated type definitions that power the core of our functionality.
6+
7+
## Understanding TypeScript Types Made Easy
8+
9+
Dive into the inner workings of our library as we break down complex TypeScript types into digestible pieces. We'll guide you through the rationale behind each type, offering clarity on how they contribute to the overall robustness of our code.
10+
11+
## Your Roadmap to TypeScript Mastery
12+
13+
Consider this section your roadmap to mastering TypeScript within the context of our library. We'll introduce you to essential type concepts and demonstrate how they enhance the predictability and reliability of your code.
14+
15+
## Demystifying TypeScript Jargon
16+
17+
If you've ever felt lost in the sea of TypeScript jargon, fear not. We're here to demystify terms, explain intricate type patterns, and provide real-world examples to solidify your understanding.
18+
19+
## Ready to Dive In? Let's Roll Up Our Sleeves
20+
21+
Equip yourself with the knowledge needed to wield TypeScript effectively in our library. Whether you're a TypeScript novice or an experienced developer, this section aims to empower you with the insights necessary to leverage the full potential of our code.

docs/index.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,7 @@ layout: home
55
hero:
66
name: "Repository"
77
tagline:
8-
"Repository Pattern implementation in TypeScript for framework agnostic
9-
usage."
8+
"Repository Pattern implementation in TypeScript for framework agnostic usage."
109
actions:
1110
- theme: brand
1211
text: Getting started
@@ -22,4 +21,7 @@ features:
2221
details: Lorem ipsum dolor sit amet, consectetur adipiscing elit
2322
- title: Local-first approach
2423
details: Lorem ipsum dolor sit amet, consectetur adipiscing elit
24+
- title: Complex typing 📖
25+
details: Explanation of composite types that will appear within application (I need to figure out where to put it (probably nest is somewhere inside Entity documentation))
26+
link: /complex-types/
2527
---

0 commit comments

Comments
 (0)