tiennm99/ghstats
1
0
Fork 0
mirror of https://github.com/tiennm99/ghstats.git synced 2026-05-19 13:26:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: resync remaining stale references after S-tier + demo changes (#5)

Browse Source 
- deployment-guide.md: embed example now lists all 14 cards (was 9).
- codebase-summary.md: FetchProductive row includes Weekday / WeekdayAllTime;
  shared helpers list adds renderWeekday, renderHeatmap, mixHex/parseHex.
- system-architecture.md: per-commit fetch diagram shows the weekday bucket
  alongside the hour bucket.
This commit is contained in:
Tien Nguyen Minh
2026-04-19 09:09:25 +07:00
committed by GitHub
parent 3e6107226f
commit 3fa396d7db
3 changed files with 16 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/codebase-summary.md
+5 -2
View File
@@ -59,7 +59,7 @@ All network I/O. Exposes a `*Client` with three fetchers; every call takes a `co
| --- | --- | --- |
| `FetchProfile(ctx, login, opts)` | username, visibility flags | Profile basics, totals, owned-repos aggregation, last-year daily calendar, `TopRepos` |
| `FetchContributionsAllTime(ctx, p, opts)` | Profile | `SeedRepos`, `DailyContributionsAllTime`, `TotalCommitsAllTime` |
| `FetchProductive(ctx, p, repos, loc, cap)` | Profile + seed + tz + cap | `Productive`, `CommitsByLanguage`, `ProductiveAllTime`, `CommitsByLanguageAllTime` |
| `FetchProductive(ctx, p, repos, loc, cap)` | Profile + seed + tz + cap | `Productive`, `Weekday`, `CommitsByLanguage`, `ProductiveAllTime`, `WeekdayAllTime`, `CommitsByLanguageAllTime` |
Call order in `main.go`: Profile → AllTime → Productive. `Client.query` handles GitHub rate limits transparently — on 429 or 403 with `X-RateLimit-Remaining: 0`, it honors `Retry-After` / `X-RateLimit-Reset` (capped at 5 minutes) and retries once.
@@ -78,8 +78,11 @@ type Card interface {
Shared helpers:
- `renderDonutCard` — language donut + legend (used by 3 language cards)
- `renderProductiveTime` — 24h bar chart (used by both productive cards)
- `renderProductiveTime` — 24h bar chart (used by both productive-time cards)
- `renderWeekday` — 7-bar day-of-week chart (used by both productive-weekday cards)
- `renderContributions` — smooth area chart (used by both contributions cards)
- `renderHeatmap` — 7×N calendar grid with `mixHex`-derived intensity ramp
- `mixHex` / `parseHex` — `#rrggbb` blending (used by heatmap, by-year, weekday for peak-vs-dim bars)
- `header`, `footer` — SVG chrome
- `niceTicks`, `formatTick` — axis math