You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+58-34Lines changed: 58 additions & 34 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,10 +1,17 @@
1
-
# Bloque SDK Documentation
1
+
# Bloque Documentation
2
2
3
-
Official documentation for the Bloque SDK.
3
+
Official documentation for Bloque - Financial Infrastructure for Developers.
4
4
5
5
## Overview
6
6
7
-
This documentation covers the **@bloque/sdk** - a TypeScript/JavaScript SDK for integrating Bloque services into your applications.
7
+
This documentation covers the **Bloque Stack** - a unified financial infrastructure platform with comprehensive tools for payments, accounts, cards, and identity verification.
8
+
9
+
### Bloque Stack
10
+
11
+
-**Bloque SDK**: Create organizations, verify identities, issue cards, and manage accounts with a single SDK
12
+
-**Bloque Payment**: Complete payment gateway to process transactions securely and efficiently
13
+
14
+
### Bloque SDK Modules
8
15
9
16
The SDK provides modules for:
10
17
@@ -39,6 +46,8 @@ bun run dev
39
46
40
47
The documentation will be available at `http://localhost:5173`
41
48
49
+
> **Note:** The SDK reference documentation is automatically downloaded and generated at runtime when you start the dev server. This ensures you always have the latest API documentation.
50
+
42
51
Build the website for production:
43
52
44
53
```bash
@@ -56,48 +65,63 @@ bun run preview
56
65
```
57
66
docs/
58
67
├── en/ # English documentation
59
-
│ ├── guide/ # Getting started guide
60
-
│ │ ├── start/ # Quick start
61
-
│ │ ├── features/ # SDK features
62
-
│ │ ├── accounts/ # Account management
63
-
│ │ └── examples/ # Code examples
64
-
│ └── index.md # Home page
68
+
│ ├── index.md # Bloque Stack home page
69
+
│ ├── sdk/ # Bloque SDK documentation
70
+
│ │ ├── index.md # SDK home page
71
+
│ │ ├── .generated # Auto-generated API reference (runtime)
│ ├── .generated # Referencia API auto-generada (runtime)
83
+
│ └── guide/ # Guías del SDK (manual)
84
+
│ ├── start/ # Inicio rápido
85
+
│ ├── features/ # Características del SDK
86
+
│ ├── accounts/ # Gestión de cuentas
87
+
│ └── examples/ # Ejemplos de código
88
+
└── payment/ # Documentación de Bloque Payment (próximamente)
72
89
```
73
90
91
+
> **Note:** Files marked with `.generated` are automatically downloaded and generated at runtime from the SDK source code. Do not edit these files manually as they will be overwritten.
92
+
74
93
## Content
75
94
76
-
### Getting Started
95
+
### Bloque Stack Overview
96
+
- Introduction to Bloque ecosystem
97
+
- Available products and tools
98
+
- Integration guides
99
+
100
+
### Bloque SDK
101
+
102
+
#### Manual Documentation
77
103
- Installation guide
78
104
- Quick start examples
79
105
- Platform support (Node.js, Bun, Deno, Browser)
80
106
- User sessions and authentication
107
+
- Code examples and tutorials
108
+
- Integration guides
81
109
82
-
### Features
83
-
- Organizations management
84
-
- Compliance (KYC/KYB)
85
-
- Account management
86
-
- Virtual cards
87
-
- Identity registration
88
-
- User sessions
89
-
90
-
### Examples
91
-
- Backend integration examples
92
-
- Virtual card creation
93
-
- User registration flows
94
-
- Session management
110
+
#### Auto-generated API Reference (Runtime)
111
+
The complete API reference is automatically generated from TypeScript source code:
112
+
- Organizations API (`@bloque/sdk-orgs`)
113
+
- Compliance API (`@bloque/sdk-compliance`)
114
+
- Accounts API (`@bloque/sdk-accounts`)
115
+
- Identity API (`@bloque/sdk-identity`)
116
+
- Core utilities (`@bloque/sdk-core`)
95
117
96
-
## Technology
118
+
This ensures the documentation is always in sync with the latest SDK version.
97
119
98
-
Built with [Rspress](https://rspress.dev/) - Fast Rspack-based documentation framework
0 commit comments