Skip to content

Commit acc675a

Browse files
committed
feat: Add sync-docs script and update deployment workflow
1 parent 5f0af19 commit acc675a

3 files changed

Lines changed: 61 additions & 34 deletions

File tree

.github/workflows/docs-deploy.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ jobs:
1616
steps:
1717
- uses: actions/checkout@v4
1818
- uses: oven-sh/setup-bun@v2
19+
- name: Sync docs content
20+
run: bun run sync-docs
1921
- name: Install dependencies
2022
run: bun install
2123
- name: Build

README.md

Lines changed: 58 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,17 @@
1-
# Bloque SDK Documentation
1+
# Bloque Documentation
22

3-
Official documentation for the Bloque SDK.
3+
Official documentation for Bloque - Financial Infrastructure for Developers.
44

55
## Overview
66

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
815

916
The SDK provides modules for:
1017

@@ -39,6 +46,8 @@ bun run dev
3946

4047
The documentation will be available at `http://localhost:5173`
4148

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+
4251
Build the website for production:
4352

4453
```bash
@@ -56,48 +65,63 @@ bun run preview
5665
```
5766
docs/
5867
├── 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)
72+
│ │ └── guide/ # SDK guides (manual)
73+
│ │ ├── start/ # Quick start
74+
│ │ ├── features/ # SDK features
75+
│ │ ├── accounts/ # Account management
76+
│ │ └── examples/ # Code examples
77+
│ └── payment/ # Bloque Payment documentation (coming soon)
6578
└── es/ # Spanish documentation
66-
├── guide/ # Guía de inicio
67-
│ ├── start/ # Inicio rápido
68-
│ ├── features/ # Características del SDK
69-
│ ├── accounts/ # Gestión de cuentas
70-
│ └── examples/ # Ejemplos de código
71-
└── index.md # Página de inicio
79+
├── index.md # Página principal de Bloque Stack
80+
├── sdk/ # Documentación de Bloque SDK
81+
│ ├── index.md # Página principal del SDK
82+
│ ├── .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)
7289
```
7390

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+
7493
## Content
7594

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
77103
- Installation guide
78104
- Quick start examples
79105
- Platform support (Node.js, Bun, Deno, Browser)
80106
- User sessions and authentication
107+
- Code examples and tutorials
108+
- Integration guides
81109

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`)
95117

96-
## Technology
118+
This ensures the documentation is always in sync with the latest SDK version.
97119

98-
Built with [Rspress](https://rspress.dev/) - Fast Rspack-based documentation framework
120+
### Bloque Payment
121+
- Complete payment gateway solution
122+
- Secure transaction processing
123+
- Documentation coming soon
99124

100-
## Repository
125+
## Links
101126

102-
GitHub: [bloque-app/sdk](https://github.com/bloque-app/sdk)
103-
NPM: [@bloque/sdk](https://www.npmjs.com/package/@bloque/sdk)
127+
- Website: [docs.bloque.app](https://docs.bloque.app)

package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
"scripts": {
66
"build": "rspress build",
77
"dev": "rspress dev",
8+
"sync-docs": "bun run ./scripts/sync-docs.ts docs",
89
"preview": "rspress preview",
910
"deploy": "wrangler pages deploy --branch=main"
1011
},

0 commit comments

Comments
 (0)