read-codebase

Scans a Laravel and Filament codebase and caches architecture documentation locally.

Updated Jun 17, 2026
One-click install
npx skills add https://github.com/ndestates/ndestates-website --skill read-codebase-ndestates
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: read-codebase
Source: https://github.com/ndestates/ndestates-website/tree/main/.copilot/skills/read-codebase
Command: npx skills add https://github.com/ndestates/ndestates-website --skill read-codebase-ndestates

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Onboarding onto a large Laravel 12 + Filament 5 codebase is slow, and re-exploring the same code in every session wastes effort. This Skill performs a structured deep read of the repository and caches the findings as local documentation and memory files for future sessions. ## Core Features & Use Cases - Guided Deep Exploration: Systematically inspects Filament resources and panel providers, signing/PDF services, Eloquent models and observers, migrations, scripts, and auth/token security. - Persistent Knowledge Cache: Writes structured docs into docs/codebase/ (architecture, structure, conventions, testing, concerns) with dated update markers, plus a repo memory file under .copilot/memories/. - Validated Findings: Requires every claim to cite concrete file paths and ends with cached knowledge locations and follow-up prompt examples. - Use Case: A developer joining the ndestates-io property valuations platform runs this Skill once to generate a full architecture reference, then reuses that cache for daily work instead of re-scanning the codebase. ## Quick Start Ask the assistant to run the read-codebase skill to scan the repository and cache its architecture documentation locally.

Frequently Asked Questions about read-codebase

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I document an unfamiliar Laravel codebase quickly?▼

Run a structured codebase scan that inspects key directories, models, migrations, and service providers, then writes the findings into markdown files under docs/codebase. This Skill automates that process and caches results for future sessions.

How to onboard developers onto a Filament admin panel project?▼

Explore the Filament resources and panel providers first, then document panel structure, conventions, and testing practices. This Skill generates ARCHITECTURE, STRUCTURE, and CONVENTIONS documents covering exactly those areas.

Does this codebase scan modify my source code?▼

No. The scan steps use read-only exploration of the repository. It only creates or updates documentation files in docs/codebase and memory cache files under .copilot/memories, leaving application code untouched.

When should I refresh the cached codebase documentation?▼

Refresh after major architectural changes, new Filament panels, or significant model and migration updates. The cache includes dated [UPDATED] markers and a .codebase-scan.txt file so you can check staleness before deciding.

What are the limitations of automated codebase documentation?▼

Generated docs reflect the code at scan time and can go stale as the project evolves. They also depend on the scan covering the right directories, so highly dynamic behavior or external services may still require manual investigation.