Automatically updates docs after every PRGet started

Automatically maintain your docs and architecture

Code Keeper is an automated maintenance system that continuously updates documentation, performs safe refactoring operations, and maintains architectural alignment in real-time. The system operates as an autonomous agent that ensures your project remains well-documented and structurally consistent.

GROWING TEAMS USE CODE KEEPER TO MAINTAIN THEIR CODE

uoguelph.course logo

Core Functionality

When code is pushed to your repository, Code Keeper automatically performs the following operations:

Detect Changes

Automatically identifies what changed in your codebase

Update Docs

Keeps README, API reference, and changelog up-to-date

Safe Refactors

Performs safe code transformations (rename, move files)

Run Tests

Executes existing tests to ensure nothing broke

Generate Pull Request

Creates a pull request containing all proposed changes for review

Safe by Default

No direct commits to the main branch. All changes are proposed through pull requests

Code Keeper functions as an automated maintenance system that continuously maintains your project documentation and architecture.

Problem Statement

Most software repositories encounter common maintenance challenges that impact long-term project health

Common Problems

  • Out-of-date documentation
  • Inconsistent folder structure
  • Awkward renames that never happen
  • Forgotten change logs
  • Messy / drifting architecture

Code Keeper Solution

Code Keeper fixes this by keeping your documentation and architecture aligned with your codebase in real-time. Every push triggers automatic updates, ensuring your project stays clean and well-documented without manual effort.

System Architecture

Overview of Code Keeper's operational workflow

1

GitHub Application Event Reception

Monitors repository for push and pull request events

2

Code Analysis Engine

Analyzes modified files, functions, and structural changes

3

Documentation Engine

Automatically updates reference documentation and markdown files including README, API documentation, and changelog

4

Refactoring Engine

Applies safe code transformations including renaming operations and file relocations

5

Test Execution Engine

Executes the existing test suite to verify that no regressions were introduced

6

Pull Request Generation

Creates a pull request containing all proposed changes for review and approval

The entire system is containerized using Docker to facilitate deployment and horizontal scaling