Documentation that stays in sync with your GitHub repository.

Connect your GitHub repository and automatically generate documentation your team can trust, without spending hours keeping it up to date.

Star on GitHub Get Started

Penqwin - Professional Engineering Documentation Platform

Acme Corp

Global Search

⌘ + K

Changeset Summary

Code Reference

src

app

auth

api

API & Endpoints

core

services

store

database

Guides

Authentication

Agentic AI

+ Create

Update Docs

Regenerate Doc

Save

Authentication & Authorization

Security is enforced at the route level through server-side session validation. Most endpoints utilize the createClient utility to interact with database, ensuring that data access respects the authenticated user's permissions.

Administrative Access

For operations that require cross-workspace visibility, state transitions that bypass high-level configuration changes (e.g., repository mapping discovery), the system utilizes superiorClient.

Authorization

is further refined by checkRole, which distinguishes between admin, read and write, and read only roles within a workspace.

API Reference

User & Profile

Method	Endpoint	Description
GET	`/api/user/profile`	Returns user data, member workspaces, and their active subscription states.

Member & Request Management

Method	Endpoint	Description
GET	`/api/members`	Lists all members with enriched user profile data.
PATCH	`/api/members/{memberId}`	Updates a member's role (`admin`, `read and write`, `read only`).
DELETE	`/api/members/{memberId}`	Removes a member from the workspace.

Why engineering teams choose Penqwin

Documentation stays current as your code evolves

Keep documentation aligned with your codebase automatically as code changes.

Understand any codebase

Generate structured documentation that makes complex repositories easier to explore.

Faster onboarding and handovers.

New developers can get up to speed quickly without digging through code history.

Onboarding

Connect in 2 minutes.

Scale

Thousands of files analysed.

Coverage

Works for private and public repositories.

Automation

Codebase to Documentation.

Sync

Smart Document Sync.

Workflow

Team Collaboration.

Compatibility

Supports 20+ programming languages.

& more...

Repository Bootstrapping

Understand your codebase from day one.

Penqwin organizes your repository into documentation for your architecture, APIs, modules, components, and business logic.

API & Endpoints

synced

Frontend & UI

synced

Utilities & Helpers

synced

Business Logic

synced

Database & Models

synced

Fix: Request handling updates

Business Logic updated

COMMIT

Merged: Refactor auth middleware

Authentication updated

Chore: Update DB schema

Database & Models updated

COMMIT

Merged: New billing endpoints

API & Endpoints updated

Generating...

Auto-sync

Documentation that evolves with your repository.

Penqwin continuously tracks pull requests and code changes to keep documentation aligned with the actual state of your system.

Built with developer trust in mind.

Penqwin only accesses repositories explicitly authorized by users. Repository data is processed securely and never used to train public AI models.

GitHub permission transparency

We request only the minimum permissions required. You always control which repositories Penqwin can read.

Secure data processing

Your code is processed in an isolated environment. We do not store raw source files beyond what's needed to generate documentation.

Never trained on your code

Your repository data is never used to train public AI models. Your intellectual property stays yours.

The Hidden Cost of Tribal Knowledge

Learn how undocumented context slows down software delivery and why engineering documentation matters.