Skip to content

docs: refresh portfolio README and wiki#53

Merged
jonathanperis merged 2 commits into
mainfrom
docs/readme-wiki-freshness-audit
May 17, 2026
Merged

docs: refresh portfolio README and wiki#53
jonathanperis merged 2 commits into
mainfrom
docs/readme-wiki-freshness-audit

Conversation

@jonathanperis
Copy link
Copy Markdown
Owner

@jonathanperis jonathanperis commented May 17, 2026

Summary

  • audited README, contributor guide, and wiki Markdown against the current Astro 6 / React 19 source tree
  • replaced stale Next.js/npm/master/deploy.yml references with Bun, Astro, src/..., and current GitHub Actions workflow details
  • refreshed architecture, project structure, deployment, SEO/analytics, resume, and terminal easter egg documentation to match the current code

Test Plan

  • git diff --check
  • bun run lint
  • bun run build
  • stale-reference grep for old Next.js/npm/workflow/env-var claims

Summary by CodeRabbit

Documentation

  • Updated development guides with current toolchain configuration and setup instructions
  • Local development server now runs on http://localhost:4321
  • Build and installation commands migrated to use Bun
  • Environment variables documentation updated (GITHUB_TOKEN, PUBLIC_GA_ID)
  • Refreshed guides covering architecture, deployment, project structure, and feature documentation

Review Change Stack

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 17, 2026

Warning

Rate limit exceeded

@jonathanperis has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 55 minutes and 52 seconds before requesting another review.

You’ve run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 6e7a1230-ae4b-4f4f-8a82-0aba6dcdc3d8

📥 Commits

Reviewing files that changed from the base of the PR and between afb1f24 and f88edb9.

📒 Files selected for processing (1)
  • wiki/project_structure.md
📝 Walkthrough

Walkthrough

Documentation across the repository's guides and wiki has been updated to reflect the portfolio's migration from Next.js 16 to Astro 6. Changes describe the new Astro architecture, Bun toolchain, development workflow, GitHub Pages deployment automation, and feature implementations including the Konami code terminal, resume page, and SEO/analytics integration.

Changes

Astro Migration Documentation

Layer / File(s) Summary
Stack Overview and Architecture
CLAUDE.md, README.md, wiki/architecture.md, wiki/index.md
Top-level descriptions, About sections, and architecture guide updated to document Astro 6 + React 19 islands instead of Next.js; describes build-time GitHub GraphQL/REST data fetching, static export to out/, and GA4 conditional loading via PUBLIC_GA_ID.
Development Toolchain and Getting Started
wiki/getting_started.md, README.md
Toolchain migrated from npm to Bun; prerequisites now include Node.js v22+, Bun, optional GitHub CLI; dev/build/lint/preview commands updated; local URL changed to http://localhost:4321; dynamic project setup uses GITHUB_TOKEN via gh auth token and PUBLIC_GA_ID for GA4 emission.
Deployment Pipeline and CI/CD
wiki/deployment.md, CLAUDE.md
GitHub Pages deployment automated via .github/workflows/main-release.yml on main branch using Bun/Node 22; static Astro export to out/ replaces Next.js serverless output; environment variables (GITHUB_TOKEN, PUBLIC_GA_ID) documented; CI/CD section updated with Bun build steps and workflow purposes.
Project Structure and Organization
wiki/project_structure.md
Repository layout changed from Next.js app/ to Astro src/-organized directories (pages/, components/, layouts/, lib/, styles/); astro.config.ts added; Key Files table references new Astro entry points and file responsibilities.
Feature Documentation
wiki/resume_page.md, wiki/easter_egg.md, wiki/seo_and_analytics.md
/resume page documented as Astro implementation rendering from src/lib/data.ts with print-optimized styling; Konami terminal activation clarified and command set updated with runCmd() mapping in Portfolio.tsx; SEO/analytics (JsonLd.astro, Analytics.astro, RootLayout.astro) documented with detailed meta tables, GA4 conditional loading, sitemap integration, and PWA manifest configuration.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: a comprehensive refresh of documentation (README and wiki) to align with the current Astro/React/Bun stack.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/readme-wiki-freshness-audit

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@wiki/project_structure.md`:
- Line 42: Update the documentation entry that references `src/lib/github.ts` to
use the correct capitalization "GitHub" (capital H) wherever "Github" appears;
specifically change the table cell description string that currently reads
"Fetches profile pinned repositories..." to use "GitHub" so the repository/file
reference and descriptive text consistently spell the project name as "GitHub".
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 5a6c97e7-2383-4d38-ae31-4d0552e177ab

📥 Commits

Reviewing files that changed from the base of the PR and between 7f61673 and afb1f24.

📒 Files selected for processing (10)
  • CLAUDE.md
  • README.md
  • wiki/architecture.md
  • wiki/deployment.md
  • wiki/easter_egg.md
  • wiki/getting_started.md
  • wiki/index.md
  • wiki/project_structure.md
  • wiki/resume_page.md
  • wiki/seo_and_analytics.md

Comment thread wiki/project_structure.md Outdated
@jonathanperis jonathanperis merged commit dff1a41 into main May 17, 2026
4 checks passed
@jonathanperis jonathanperis deleted the docs/readme-wiki-freshness-audit branch May 17, 2026 05:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant