Skip to content

Commit 5f73f39

Browse files
committed
docs: fix Jekyll permalinks and update documentation URL
- Add Jekyll front matter to all documentation pages - Fix permalinks for proper GitHub Pages navigation - Update pyproject.toml documentation URL to GitHub Pages - Ensure all pages are accessible via navigation
1 parent a9aaee0 commit 5f73f39

10 files changed

Lines changed: 146 additions & 110 deletions

docs/api_reference.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,14 @@
1+
---
2+
layout: page
3+
title: API Reference
4+
permalink: /api_reference/
5+
---
6+
17
# Pathao Python SDK - API Reference
28

39
**Version:** 0.1.0
410
**Last Updated:** January 2026
5-
**Status:** Complete Implementation
11+
**Status:** Complete Implementation
612

713
---
814

@@ -28,7 +34,7 @@
2834

2935
The Pathao Python SDK provides a clean, Pythonic interface to the Pathao Courier Merchant API. It handles authentication, request/response serialization, error handling, and provides convenient methods for all supported operations.
3036

31-
### Features
37+
### Features
3238

3339
- OAuth 2.0 authentication with automatic token refresh
3440
- Type hints throughout the codebase

docs/development_guide.md

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
# Pathao Python SDK - Development Guide
22

33
**For Contributors and Maintainers**
4-
**Status:** Complete Implementation
4+
**Status:** Complete Implementation
55

66
---
77

88
## Project Overview
99

1010
The Pathao Python SDK is a production-ready Python package that provides a comprehensive interface to the Pathao Courier Merchant API. This guide covers the architecture, implementation details, and development workflow for contributors.
1111

12-
### Implementation Status
12+
### Implementation Status
1313

1414
- **Complete Implementation:** All 15 phases completed
1515
- **Test Coverage:** 97% with 196 unit tests
@@ -22,7 +22,7 @@ The Pathao Python SDK is a production-ready Python package that provides a compr
2222

2323
## Project Structure
2424

25-
### Directory Tree
25+
### Directory Tree
2626

2727
```
2828
pathao-python/
@@ -95,7 +95,7 @@ pathao-python/
9595

9696
## Architecture Overview
9797

98-
### System Architecture
98+
### System Architecture
9999

100100
```
101101
┌─────────────────────────────────────────┐
@@ -160,7 +160,7 @@ pathao-python/
160160

161161
### Core Components
162162

163-
#### 1. Exception Hierarchy
163+
#### 1. Exception Hierarchy
164164

165165
**File:** `pathao/exceptions.py`
166166

@@ -180,7 +180,7 @@ PathaoException (base)
180180
- Field-specific validation error details
181181
- Retry information for network errors
182182

183-
#### 2. Data Models
183+
#### 2. Data Models
184184

185185
**File:** `pathao/models.py`
186186

@@ -197,7 +197,7 @@ PathaoException (base)
197197
- JSON serialization support
198198
- Validation in `__post_init__` where needed
199199

200-
#### 3. Input Validation
200+
#### 3. Input Validation
201201

202202
**File:** `pathao/validators.py`
203203

@@ -212,7 +212,7 @@ PathaoException (base)
212212
- `validate_item_type()` - Enum validation (1, 2)
213213
- `validate_integer_range()` - Generic range validation
214214

215-
#### 4. HTTP Client
215+
#### 4. HTTP Client
216216

217217
**File:** `pathao/http_client.py`
218218

@@ -224,7 +224,7 @@ PathaoException (base)
224224
- Request/response logging (non-sensitive data)
225225
- Session-based connection pooling
226226

227-
#### 5. Authentication Module
227+
#### 5. Authentication Module
228228

229229
**File:** `pathao/modules/auth.py`
230230

@@ -235,7 +235,7 @@ PathaoException (base)
235235
- Intelligent fallback to password grant if refresh fails
236236
- Thread-safe in-memory token storage
237237

238-
#### 6. Service Modules
238+
#### 6. Service Modules
239239

240240
**Store Module** (`pathao/modules/store.py`):
241241
- Create stores with comprehensive validation
@@ -316,7 +316,7 @@ pre-commit run --all-files
316316

317317
### Testing Strategy
318318

319-
#### Unit Tests (196 tests, 97% coverage)
319+
#### Unit Tests (196 tests, 97% coverage)
320320

321321
**Test Structure:**
322322
```
@@ -346,7 +346,7 @@ tests/
346346
- Error condition testing
347347
- Integration tests with real sandbox API
348348

349-
#### Integration Tests
349+
#### Integration Tests
350350

351351
**Real Sandbox Testing:**
352352
- Authentication flow validation
@@ -355,7 +355,7 @@ tests/
355355
- Concurrent operation testing
356356
- Environment configuration testing
357357

358-
### Code Style Standards
358+
### Code Style Standards
359359

360360
#### PEP 8 Compliance
361361
- 4-space indentation
@@ -388,11 +388,11 @@ def create_order(self, store_id: int, recipient_name: str) -> Order:
388388

389389
---
390390

391-
## CI/CD Pipeline
391+
## CI/CD Pipeline
392392

393393
### GitHub Actions Workflows
394394

395-
#### 1. Tests Workflow (`.github/workflows/tests.yml`)
395+
#### 1. Tests Workflow (`.github/workflows/tests.yml`)
396396

397397
```yaml
398398
# Runs on: push, pull_request
@@ -405,7 +405,7 @@ def create_order(self, store_id: int, recipient_name: str) -> Order:
405405
# - Coverage upload to Codecov
406406
```
407407

408-
#### 2. Quality Workflow (`.github/workflows/quality.yml`)
408+
#### 2. Quality Workflow (`.github/workflows/quality.yml`)
409409

410410
```yaml
411411
# Runs on: push, pull_request
@@ -415,7 +415,7 @@ def create_order(self, store_id: int, recipient_name: str) -> Order:
415415
# - Dependency checking
416416
```
417417

418-
#### 3. Publish Workflow (`.github/workflows/publish.yml`)
418+
#### 3. Publish Workflow (`.github/workflows/publish.yml`)
419419

420420
```yaml
421421
# Runs on: release creation
@@ -425,7 +425,7 @@ def create_order(self, store_id: int, recipient_name: str) -> Order:
425425
# - Create GitHub release
426426
```
427427

428-
### Pre-commit Hooks
428+
### Pre-commit Hooks
429429

430430
**Configuration:** `.pre-commit-config.yaml`
431431

@@ -440,7 +440,7 @@ def create_order(self, store_id: int, recipient_name: str) -> Order:
440440

441441
## Release Management
442442

443-
### Version Strategy
443+
### Version Strategy
444444

445445
**Semantic Versioning (MAJOR.MINOR.PATCH):**
446446
- Current version: `0.1.0` (alpha release)
@@ -451,7 +451,7 @@ def create_order(self, store_id: int, recipient_name: str) -> Order:
451451
- `pyproject.toml`
452452
- `pathao/__init__.py`
453453

454-
### Release Process
454+
### Release Process
455455

456456
1. **Update version** in all locations
457457
2. **Update CHANGELOG.md** with new features/fixes
@@ -460,7 +460,7 @@ def create_order(self, store_id: int, recipient_name: str) -> Order:
460460
5. **Push tag** to trigger automated PyPI publishing
461461
6. **Create GitHub release** with release notes
462462

463-
### PyPI Publishing
463+
### PyPI Publishing
464464

465465
**Automated via GitHub Actions:**
466466
- Triggered on release creation
@@ -481,7 +481,7 @@ def create_order(self, store_id: int, recipient_name: str) -> Order:
481481
5. **Run quality checks** locally
482482
6. **Submit pull request** with clear description
483483

484-
### Pull Request Requirements
484+
### Pull Request Requirements
485485

486486
- [ ] All tests passing
487487
- [ ] Code coverage maintained (>95%)
@@ -490,7 +490,7 @@ def create_order(self, store_id: int, recipient_name: str) -> Order:
490490
- [ ] CHANGELOG.md updated
491491
- [ ] Commit messages follow conventional format
492492

493-
### Issue Templates
493+
### Issue Templates
494494

495495
**Bug Report Template:**
496496
- Environment information
@@ -506,7 +506,7 @@ def create_order(self, store_id: int, recipient_name: str) -> Order:
506506

507507
---
508508

509-
## Security Considerations
509+
## Security Considerations
510510

511511
### Implemented Security Measures
512512

@@ -532,7 +532,7 @@ def create_order(self, store_id: int, recipient_name: str) -> Order:
532532

533533
---
534534

535-
## Performance Considerations
535+
## Performance Considerations
536536

537537
### Optimization Strategies
538538

docs/error_handling.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
layout: page
3+
title: Error Handling
4+
permalink: /error_handling/
5+
---
6+
17
# Error Handling
28

39
## Overview

0 commit comments

Comments
 (0)