Welcome to Penqwin

Everything you need to successfully launch, configure, and scale your autonomous technical documentation with Penqwin.

01. Onboarding 02. Bootstrapping 03. Updates

Quick Start & Onboarding

Welcome to Penqwin! Penqwin makes it seamless to create, manage, and scale engineering documentation directly linked to your source code. Our agentic parser scans code architecture, interprets functional flows, and keeps documents up-to-date automatically. Follow our step-by-step onboarding guide to set up your workspace and integrate your first repository.

Step 01

Account Creation & Authentication

To get started, authenticate with your secure account at app.penqwin.com. Penqwin offers dual OAuth options tailored to different workspace roles:

GitHub OAuth
Recommended

Associates your account with your GitHub profile. Essential for developers, managers, and admins who need write access, branch syncs, and PR documentation generation.

Google OAuth

Ideal for product managers, writers, view-only stakeholders, and team members who only need read access, workspace navigation, or team administration.

Authentication Screen Interface
Step 02

Create a New Organization

If you are setting up Penqwin for your company, team, or personal projects for the first time, you will start by creating a new Organization. Organizations serve as the top-level home for your documents.

Create Organization Form Interface

To create an organization:

  1. Navigate to the "Create new" section on workspace setup page.
  2. Upload workspace logo and enter workspace name.
  3. Enter workspace handle, it should be unique.
  4. Click "Launch Dashboard" to initialize your workspace. Once initialized, you can begin connecting your source code repositories.
Step 03

Join an Existing Organization

If your team or company has already set up a Penqwin workspace, you do not need to create a new organization. Instead, you can join the existing organization to access shared code documentation.

Join Organization Interface

To join an organization:

  1. Search for your workspace handle.
  2. Click the Request to Join button.
  3. The workspace admin receives your join request. once approved, you will be able to access the workspace.

Repository Bootstrapping

Bootstrapping parses your entire codebase root to produce a comprehensive starter technical workspace. Rather than writing documentation from scratch, our agents map your codebase directory outline, discover API endpoints, and establish architectural modules.

Running Bootstrapping

  1. Navigate to the settings → Integrations tab.
  2. Select the repository you want to bootstrap.
  3. Click on Bootstrap Repo button.
  4. The agent indexes your entire codebase root to produce the structured engineering documents.
  5. Once the initial bootstrapping is done, you can review the updated documents in the sidebar under Code Reference folder.

Document Updation & Sync Loop

Ensure your engineering documentation stays in sync with your codebase evolution. Penqwin analyzes pull request diffs, parses modified files, and drafts surgical updates to your documents, allowing you to review and accept or reject adjustments before they are applied.

Sync docs

  1. Click the Update Docs button in sidebar.
  2. Enter the code change (pull request/merge) url.
  3. Click on Generate button.
  4. The agent processes the code changes and surgically updates the relevant sections of the engineering documents for review.
  5. Once the doc generation is done, you can review the changes and accept or reject them.
  6. On accepting, the changes are applied to the documentation.