Skip to content

Commit 5f0af19

Browse files
committed
feat: Add initial documentation structure for Bloque SDK
- Create English and Spanish navigation files for the SDK guide. - Add homepage content for the Bloque SDK with features and introduction links. - Generate directories for SDK documentation with deployment notes. - Define TypeScript declarations for MDX and raw imports. - Include an icon for the Bloque SDK in the public directory. - Implement internationalization JSON for frontend and backend terms. - Initialize package.json with build and deployment scripts for documentation. - Configure rspress with plugins for preview and sitemap generation. - Develop a Tag component for displaying tags with different styles. - Set up TypeScript configuration for the project. - Add Wrangler configuration for Cloudflare Workers deployment.
0 parents  commit 5f0af19

26 files changed

Lines changed: 1657 additions & 0 deletions

.editorconfig

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
root = true
2+
3+
[*]
4+
indent_style = space
5+
indent_size = 2
6+
tab_width = 2
7+
end_of_line = lf
8+
insert_final_newline = true
9+
trim_trailing_whitespace = true

.github/workflows/docs-deploy.yml

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: Deploy docs to Production
2+
3+
on:
4+
workflow_dispatch: # Manual trigger
5+
push:
6+
branches:
7+
- main
8+
9+
env:
10+
CLOUDFLARE_API_TOKEN: ${{ secrets.CLOUDFLARE_API_TOKEN }}
11+
CLOUDFLARE_ACCOUNT_ID: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
12+
13+
jobs:
14+
deploy:
15+
runs-on: ubuntu-latest
16+
steps:
17+
- uses: actions/checkout@v4
18+
- uses: oven-sh/setup-bun@v2
19+
- name: Install dependencies
20+
run: bun install
21+
- name: Build
22+
run: bun run build
23+
- name: Deploy to Cloudflare Pages production
24+
uses: cloudflare/wrangler-action@v3
25+
with:
26+
apiToken: ${{ env.CLOUDFLARE_API_TOKEN }}
27+
accountId: ${{ env.CLOUDFLARE_ACCOUNT_ID }}
28+
command: pages deploy --branch=main

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
node_modules
2+
3+
doc_build

.vscode/extensions.json

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"recommendations": [
3+
"oven.bun-vscode",
4+
"biomejs.biome",
5+
"editorconfig.editorconfig"
6+
]
7+
}

.vscode/settings.json

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
{
2+
"typescript.tsdk": "./node_modules/typescript/lib",
3+
"typescript.enablePromptUseWorkspaceTsdk": true,
4+
"editor.codeActionsOnSave": {
5+
"source.organizeImports": "explicit"
6+
},
7+
"editor.formatOnSave": true,
8+
"[javascript]": {
9+
"editor.defaultFormatter": "biomejs.biome"
10+
},
11+
"[typescript]": {
12+
"editor.defaultFormatter": "biomejs.biome"
13+
}
14+
}

README.md

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
# Bloque SDK Documentation
2+
3+
Official documentation for the Bloque SDK.
4+
5+
## Overview
6+
7+
This documentation covers the **@bloque/sdk** - a TypeScript/JavaScript SDK for integrating Bloque services into your applications.
8+
9+
The SDK provides modules for:
10+
11+
- **Organizations** (`@bloque/sdk-orgs`): Organization management
12+
- **Compliance** (`@bloque/sdk-compliance`): KYC/KYB compliance services
13+
- **Accounts** (`@bloque/sdk-accounts`): Account and virtual card management
14+
- **Identity** (`@bloque/sdk-identity`): User identity and authentication
15+
- **Core** (`@bloque/sdk-core`): Base client and shared utilities
16+
17+
## Languages
18+
19+
The documentation is available in:
20+
21+
- English (`/en`)
22+
- Spanish (`/es`)
23+
24+
## Setup
25+
26+
Install the dependencies:
27+
28+
```bash
29+
bun install
30+
```
31+
32+
## Get started
33+
34+
Start the dev server:
35+
36+
```bash
37+
bun run dev
38+
```
39+
40+
The documentation will be available at `http://localhost:5173`
41+
42+
Build the website for production:
43+
44+
```bash
45+
bun run build
46+
```
47+
48+
Preview the production build locally:
49+
50+
```bash
51+
bun run preview
52+
```
53+
54+
## Documentation Structure
55+
56+
```
57+
docs/
58+
├── 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
65+
└── 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
72+
```
73+
74+
## Content
75+
76+
### Getting Started
77+
- Installation guide
78+
- Quick start examples
79+
- Platform support (Node.js, Bun, Deno, Browser)
80+
- User sessions and authentication
81+
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
95+
96+
## Technology
97+
98+
Built with [Rspress](https://rspress.dev/) - Fast Rspack-based documentation framework
99+
100+
## Repository
101+
102+
GitHub: [bloque-app/sdk](https://github.com/bloque-app/sdk)
103+
NPM: [@bloque/sdk](https://www.npmjs.com/package/@bloque/sdk)

biome.json

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
{
2+
"$schema": "https://biomejs.dev/schemas/2.3.10/schema.json",
3+
"assist": {
4+
"actions": {
5+
"source": {
6+
"organizeImports": "on"
7+
}
8+
}
9+
},
10+
"vcs": {
11+
"enabled": true,
12+
"clientKind": "git",
13+
"useIgnoreFile": true
14+
},
15+
"formatter": {
16+
"indentStyle": "space"
17+
},
18+
"linter": {
19+
"enabled": true,
20+
"rules": {
21+
"recommended": true
22+
}
23+
},
24+
"javascript": {
25+
"formatter": {
26+
"quoteStyle": "single"
27+
}
28+
}
29+
}

0 commit comments

Comments
 (0)