Welcome
An overview of Code Keeper’s goals and how the docs are organised.
Code Keeper is your autonomous maintenance teammate. It keeps documentation, architecture notes, and safe refactors up to date by opening reviewable pull requests in your repository.
This guide walks through three moments that matter most: connecting GitHub, exploring dashboards, and working with the automated pull requests that Code Keeper creates.
Connect GitHub
Install the GitHub App, authenticate, and revisit connection status.
Install the Code Keeper GitHub App for the repositories you want maintained. The app requests repo-level permissions so it can read changes and open pull requests on your behalf—never direct pushes.
Sign in to the Code Keeper web app using the same GitHub account. After OAuth completes, you’ll land back at `/dashboard` with the active session stored securely.
If tokens expire or access gets revoked, the dashboard shows a reconnect banner. Re-authorise with a single click—no manual clean up required.
Dashboard tour
See what’s available once your account is linked.
Repository list: Each connected repo displays metadata pulled from GitHub—stars, forks, visibility, open issues, last push, and default branch.
Structure explorer: Browse the file tree exactly as Code Keeper sees it. Expand folders, inspect files, and click a file to preview syntax-highlighted content. External links jump straight to GitHub when needed.
Pull request panel: View the latest open, closed, and merged PRs. The “View details” link opens a dedicated page showing branch targets, labels, reviewers, commit history, and file changes.
Maintenance workflow
Understand how Code Keeper’s automation fits into daily work.
On every change, Code Keeper drafts documentation updates, safe refactor patches, and architecture notes, then opens a pull request. Humans stay in the loop—the system never commits directly to your default branch.
Review the PR like you would a teammate’s submission. Everything is attributable and traceable. Merge when you are satisfied or request adjustments in GitHub comments.
Need to pause automation? Revoke the GitHub App for specific repositories or reach out for support. Historical PRs remain accessible for audits and retrospectives.
Support & feedback
Share feedback or ask questions directly with the builder.
I’m Faiz Mustansar, and I respond personally to support emails. Whether you found a bug, have an idea, or just want to talk process, I’d love to hear from you.
Email: faizmustansar10@gmail.com