Skip to content

Commit 691efcd

Browse files
committed
docs: complete documentation overhaul and changelog update
1 parent e2a9ccd commit 691efcd

41 files changed

Lines changed: 3357 additions & 384 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

CHANGELOG.md

Lines changed: 26 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -5,32 +5,35 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8-
## [Unreleased]
8+
## [1.1.0] - 2026-01-22
99

10-
### Added
11-
- **SDK**: Introduced `@opencodehub/sdk`, a TypeScript Client for programmatically interacting with the OpenCodeHub API.
12-
- **CLI**: Released `opencodehub-cli` (v1.0.1) to npm.
13-
- Added `och` command globally.
14-
- Implemented smoke tests for CLI verification.
15-
- **Documentation**:
16-
- Added comprehensive "Roadmap" to `README.md` for Q2-Q4 2026.
17-
- Added `docs/publishing.md` guide for CLI release management.
18-
- **Assets**: Updated project logo to SVG format.
10+
### 📚 Documentation (Major Overhaul)
11+
- **Structure**: Reorganized `docs/` into a comprehensive knowledge base (`getting-started`, `guides`, `tutorials`, `api`, `administration`).
12+
- **Visuals**:
13+
- Added **Mermaid.js** C4 Architecture diagrams.
14+
- Added **Git Graph** diagrams for workflow comparisons.
15+
- Created custom SVGs for `stack-workflow` and `architecture`.
16+
- **New Guides**:
17+
- **Production Installation**: Detailed hardware specs, Nginx config, and go-live checklist.
18+
- **API Reference**: Swagger-style documentation with JSON examples and parameter tables.
19+
- **Troubleshooting**: Solutions for common errors (Docker, 403s, Database).
20+
- **CLI Reference**: Unified command list for `opencodehub-cli`.
21+
- **Glossary**: Definitions for core terms like "Stacked PRs" and "Merge Queue".
1922

20-
### Changed
21-
- **Logs**: Cleaned up production code by removing debug `console.log` statements in:
22-
- `src/pages/[owner]/[repo]/milestones/index.astro`
23-
- `src/pages/[owner]/[repo]/settings/deploy-keys.astro`
24-
- `src/pages/[owner]/[repo]/wiki/index.astro`
25-
- `src/pages/[owner]/[repo]/actions/index.astro`
26-
- **Repo Links**: Updated all hardcoded GitHub repository URLs to point to `swadhinbiswas/OpencodeHub`.
23+
### 💻 CLI (`v1.1.0`)
24+
- **UI Polish**:
25+
- Implemented "Dracula" theme for consistent coloring.
26+
- Added ASCII art logo and gradient banners.
27+
- Replaced raw logs with animated spinners (`ora`) and progress bars.
28+
- Added "Success Boxes" for clearer operation summaries.
29+
- **Commands**:
30+
- `och stack view`: Now displays a visual ASCII tree of the current stack.
31+
- `och push`: Shows PR compilation status and links.
2732

28-
### Fixed
29-
- **Security**: Fixed Critical Authorization Bypass in Issue Creation API (`issues/index.ts`).
30-
- Now correctly checks `canReadRepo` before inserting issues.
31-
- **Security**: Fixed Privacy Leak in Collaborators List API (`collaborators/index.ts`).
32-
- Added permission check to prevent unauthorized users from enumerating members of private repositories.
33-
- **CLI**: Fixed incorrect binary path in `cli/package.json` that prevented global execution.
33+
### 🛡 Security & Fixes
34+
- **Authorization**: Fixed critical bypass in `issues/index.ts` and `collaborators/index.ts`.
35+
- **Fixes**: Resolved incorrect binary path in CLI package.json.
36+
- **Repo Links**: Updated hardcoded GitHub links to the official repository.
3437

3538
## [0.2.0] - 2026-01-21
3639

README.md

Lines changed: 37 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,28 @@
11
# OpenCodeHub
22

33
<p align="center">
4-
<img src="public/logo.svg" alt="OpenCodeHub Logo" width="200">
4+
<img src="public/logo.svg" alt="OpenCodeHub Logo" width="300">
5+
<br>
56
</p>
67

78
<p align="center">
8-
<strong>A powerful, self-hosted Git platform with CI/CD, code review, and enterprise-grade security</strong>
9+
<strong>The self-hosted Git platform for high-velocity teams.</strong><br>
10+
Built for stacked PRs, AI code review, and enterprise security.
11+
</p>
12+
13+
<p align="center">
14+
<a href="https://www.npmjs.com/package/opencodehub-cli"><img src="https://img.shields.io/npm/v/opencodehub-cli?style=flat-square&color=bd93f9&label=CLI" alt="npm version"></a>
15+
<a href="LICENSE"><img src="https://img.shields.io/github/license/swadhinbiswas/OpenCodeHub?style=flat-square&color=50fa7b" alt="License"></a>
16+
<a href="https://github.com/swadhinbiswas/OpenCodeHub/actions"><img src="https://img.shields.io/github/actions/workflow/status/swadhinbiswas/OpenCodeHub/ci.yml?branch=main&style=flat-square&color=8be9fd" alt="Build Status"></a>
17+
<a href="https://docker.com"><img src="https://img.shields.io/badge/docker-ready-blue?style=flat-square&logo=docker" alt="Docker"></a>
918
</p>
1019

1120
<p align="center">
1221
<a href="#-features">Features</a> •
22+
<a href="#-architecture">Architecture</a> •
1323
<a href="#-quick-start">Quick Start</a> •
14-
<a href="#%EF%B8%8F-configuration">Configuration</a> •
15-
<a href="#-security">Security</a> •
16-
<a href="#-production-deployment">Production</a> •
17-
<a href="#-api">API</a> •
24+
<a href="#-och-cli---command-line-interface">CLI</a> •
25+
<a href="#-advanced-features">Advanced Features</a> •
1826
<a href="#-contributing">Contributing</a>
1927
</p>
2028

@@ -70,6 +78,25 @@
7078

7179
---
7280

81+
82+
---
83+
84+
## 🏗 Architecture
85+
86+
<p align="center">
87+
<img src="public/architecture.svg" alt="System Architecture" width="800">
88+
</p>
89+
90+
OpenCodeHub is built on a modern, scalable architecture designed for performance and flexibility.
91+
92+
- **Frontend**: Astro + React for high-performance UI.
93+
- **Backend API**: tRPC + Node.js for type-safe communication.
94+
- **Git Server**: Custom implementation over standard Git protocols (HTTP/SSH).
95+
- **Database**: Drizzle ORM supporting PostgreSQL, MySQL, and SQLite.
96+
- **Storage**: Pluggable storage system (S3, R2, G-Drive, Local).
97+
98+
---
99+
73100
## 📦 Quick Start
74101

75102
### Prerequisites
@@ -205,12 +232,10 @@ och status # Show stack status (alias: st)
205232

206233
#### How It Works
207234

208-
```text
209-
main
210-
└── PR #123: Add database schema
211-
└── PR #124: Add authentication service
212-
└── PR #125: Add login UI
213-
```
235+
![Stacked PR Workflow](public/stack-workflow.svg)
236+
<br>
237+
238+
Each PR builds on the previous one. When #123 merges, #124 automatically rebases.
214239

215240
Each PR builds on the previous one. When #123 merges, #124 automatically rebases.
216241

cli/CHANGELOG.md

Lines changed: 59 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,67 @@
11
# Changelog
22

3-
All notable changes to this project will be documented in this file.
3+
All notable changes to OpenCodeHub CLI will be documented in this file.
44

55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8-
## [1.0.0] - 2026-01-17
8+
## [1.1.0] - 2026-01-22
99

1010
### Added
11-
- Initial release of OpenCodeHub CLI
12-
- `och auth` - Authentication commands (login, logout, whoami)
13-
- `och stack` - Stack management (create, view, submit, sync, reorder)
14-
- `och init` - Repository initialization
15-
- `och status` - Stack status display
16-
- `och config` - Configuration management
17-
- Support for stacked pull requests
18-
- Interactive prompts with Inquirer.js
19-
- Progress spinners with Ora
20-
- Colorful output with Chalk
21-
22-
### Features
23-
- Stack-first PR workflow
24-
- Automatic PR dependency linking
25-
- Smart stack rebasing
26-
- Token-based authentication for CI/CD
27-
- Cross-platform support (Windows, macOS, Linux)
11+
- 🎨 **Production-Grade UI Overhaul**
12+
- GitHub-like progress indicators for push operations
13+
- Beautiful ASCII art logos with gradient colors
14+
- Real-time upload/download speed indicators
15+
- Professional boxed success/error messages
16+
- Color-coded output throughout (green=success, red=error, cyan=info)
17+
- Smooth spinners for long operations
18+
- Object enumeration and compression progress display
19+
20+
- **New Utility Modules**
21+
- `branding.ts` - ASCII art, logos, and color schemes
22+
- `progress.ts` - GitHub-style progress indicators and formatters
23+
- `formatter.ts` - Boxed message formatting
24+
25+
- **UI Dependencies**
26+
- `boxen@^7.1.1` - Beautiful bordered boxes
27+
- `figlet@^1.7.0` - ASCII art text
28+
- `gradient-string@^2.0.2` - Gradient colors
29+
- `cli-progress@^3.12.0` - Progress bars
30+
31+
### Changed
32+
- **Enhanced `och push` command**
33+
- Now shows GitHub-style object enumeration
34+
- Displays compression progress with thread count
35+
- Shows upload speed in real-time
36+
- Beautiful ref update notifications
37+
- Success box with repository details and view URL
38+
39+
- **Enhanced `och clone` command**
40+
- Repository info spinner
41+
- Success box with clone location
42+
- Helpful next-step commands
43+
44+
- **Enhanced `och create` command**
45+
- ASCII celebration art on success
46+
- Detailed info box with repository details
47+
- Visual indication of public/private status
48+
- Shows if remote was added to current repo
49+
50+
### Improved
51+
- Error messages now appear in formatted error boxes
52+
- Better visual hierarchy with colors and formatting
53+
- More professional and polished user experience
54+
- GitHub-like workflow feel
55+
56+
## [1.0.1] - 2024-XX-XX
57+
58+
### Fixed
59+
- Minor bug fixes and improvements
60+
61+
## [1.0.0] - 2024-XX-XX
62+
63+
### Added
64+
- Initial release
65+
- Basic repository operations (push, clone, create)
66+
- Authentication system
67+
- Configuration management

0 commit comments

Comments
 (0)