Help, Documentation & Guides

Clear, step-by-step instructions to configure your GitHub integrations, resolve visibility blockers, and maximize your triage velocity.

Grant Organization Access
Missing an org? Grant or approve third-party OAuth access directly in your GitHub settings.
Interactive Sandbox Demo
Experience live dual-stream issue and PR triage without connecting your GitHub credentials.
Direct Engineering Support
Have questions, feedback, or custom requirements? Send a message via our Resend contact form.
OrganizationsMost Common
Why are my GitHub organizations not appearing in the workspace menu?
Summary: Organization access restrictions or private membership visibility on GitHub may prevent organizations from syncing.
Step-by-Step Instructions
1Navigate to GitHub Settings -> Applications -> Authorized OAuth Apps (or visit https://github.com/settings/applications).
2Select "GitTrackr" from the list of authorized applications.
3Under "Organization access", find your organization and click "Grant" or "Request access". If an organization enforces SAML SSO, complete the SSO authorization step.
4Alternatively, visit your organization page on GitHub (https://github.com/orgs/<your-org>/people), locate your username, and change your membership visibility from "Private" to "Public".
5Return to GitTrackr and refresh the dashboard. Your organizations will immediately populate in the dropdown workspace switcher.
Pro Tip: If your organization has 0 public repositories or restricted internal access, GitTrackr gracefully defaults to 0 items to prevent GitHub 422 API errors. You can switch between personal repositories and organizational dashboards at any time from the avatar menu.
Getting StartedOverview
What is GitTrackr and how does it optimize my engineering workflow?
Summary: A unified developer cockpit consolidating pull requests, assigned issues, review turnaround, and team velocity across all your repositories.
Step-by-Step Instructions
1Sign In using your GitHub account via scoped OAuth. No database setup or configuration required.
2GitTrackr automatically indexes your active pull requests (authored and reviewing) and assigned backlog issues across your personal and organizational repos.
3Use the top multi-state KPI cards to filter immediately by Open PRs, Merged PRs, Assigned Issues, or Closed Issues.
4Open the Velocity Telemetry graph to monitor your 7-day, 4-week, or quarterly shipping cadence and review SLAs.
Pro Tip: You do not need to keep 15 separate GitHub notification tabs open. GitTrackr provides a single triage pane with zero latency.
Features & Cockpit
How do the clickable KPI cards and multi-state filters work?
Summary: Interactive telemetry filters allowing instant drill-down into open work items, merged contributions, and backlog tasks.
Step-by-Step Instructions
1Click on any KPI card at the top of the dashboard ("Open PRs", "Merged PRs", "Assigned Issues", "Closed Issues") to filter the item list instantly.
2Clicking an already active KPI card toggles the filter back to "All" items.
3Use the search bar to filter by PR/issue title or repository name simultaneously with any active status filter.
4Click the "Reset" button in the filter bar at any time to clear all active query tags and restore the default view.
Pro Tip: Filter states automatically sync to the browser URL (e.g. ?tab=pullrequests&filter=open), so you can bookmark or share your exact filtered view.
Security & Limits
How does GitTrackr prevent GitHub API rate limits (403 / 429)?
Summary: Intelligent in-memory caching, request collapsing, and paginated on-demand ingestion safeguard your quota.
Step-by-Step Instructions
1All GitHub API responses (organizations, repositories, search queries, and language statistics) are cached in-memory with a 3 to 5-minute TTL.
2Switching between tabs, filters, or views serves cached data instantly without firing redundant network requests.
3Queries are paginated with on-demand "Load More" controls (20 items at a time), eliminating explosive concurrent background requests.
4GitTrackr continuously inspects x-ratelimit-remaining and x-ratelimit-reset response headers to protect your 30 req/min search quota.
Pro Tip: In the rare event that GitHub rate limits are reached, GitTrackr displays a friendly banner indicating when the quota resets instead of crashing.
Security & LimitsSecurity
Is my source code or token stored on any server?
Summary: GitTrackr operates on a strict zero-database, privacy-first architecture.
Step-by-Step Instructions
1GitTrackr stores NO user source code, repository contents, or database records on disk.
2Your GitHub OAuth token is stored exclusively in an encrypted, HTTP-only session cookie managed by NextAuth.
3All GitHub queries execute directly between your client browser and GitHub APIs using scoped bearer tokens.
4Signing out completely clears all session cookies and local cache immediately.
Pro Tip: GitTrackr only requests read-level permissions necessary to display your assigned issues, pull requests, and public organization memberships.
Features & Cockpit
How is the Contribution Streak and Activity Calendar calculated?
Summary: A layout-stable contribution heatmap paired with active streak telemetry and shipping consistency metrics.
Step-by-Step Instructions
1Current Streak: The consecutive number of days with active GitHub contributions (commits, PRs, or issue interactions).
2Longest Streak: Your historical personal record for consecutive contribution days.
3Total Contributions: Cumulative metric tracking indexed PRs, backlog issues, and commits.
4Consistency Rate: The percentage of active sprint weeks with verified shipped contributions.
Pro Tip: Clicking any streak KPI card on your Profile page automatically scrolls smoothly to the Contribution Heatmap with a cyan highlight pulse. Hovering over calendar cells displays exact date and contribution counts with zero cumulative layout shift (CLS).
Troubleshooting
What should I do if a repository or issue returns a 422 error?
Summary: Understanding GitHub 422 Unprocessable Entity responses for empty or restricted targets.
Step-by-Step Instructions
1GitHub returns HTTP 422 when a search qualifier (e.g. org:<name>) targets an organization with zero searchable public repositories, or an organization requiring SAML authorization.
2GitTrackr automatically detects 422 responses and resolves them gracefully with an empty state rather than freezing the UI.
3If you expect issues to be present, verify that your OAuth token has third-party access granted in your organization settings, and that the organization has active repositories.
Pro Tip: Check the browser console; GitTrackr outputs clear diagnostic notices rather than uncaught errors.
Getting StartedDemo Mode
Can I test GitTrackr without connecting my personal GitHub account?
Summary: Try GitTrackr instantly with the fully interactive Sandbox Demo Mode.
Step-by-Step Instructions
1Navigate to http://localhost:3000/dashboard/octocat or click "Live Demo" in the navigation bar.
2Explore live dual-stream issue and PR triage, toggle KPI cards, test search queries, and switch Velocity Telemetry timeframes.
3Visit the landing page interactive cockpit to test components with simulated data.
4Once ready to track your real workload, click "Sign In with GitHub" to connect your account.
Pro Tip: Demo mode generates realistic telemetry anchored to GitHub’s octocat mascot profile.

Need further assistance or found a bug?

Our engineering team is active and ready to help. Reach out directly and we'll get back to you promptly.

Contact Support