Skip to content

Update README project structure diagram to match current repository layout #621

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jbampton merged 1 commit into from
Sep 26, 2026
Merged

Update README project structure diagram to match current repository layout #621

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 24 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -323,27 +323,34 @@ NextCommunity.github.io/
│ │ ├── codespell.txt # Accepted words for spell checks
│ │ └── zizmor.yml # GitHub Actions security lint config
│ ├── workflows/
│ │ ├── deploy.yml # Deployment workflow
│ │ ├── prek-audit.yml # prek audit workflow
│ │ ├── prek-manual.yml # Manual prek workflow
│ │ ├── prek.yml # Standard prek workflow
│ │ └── super-linter.yml # Super-linter workflow
│ │ ├── deploy.yml # Production deployment workflow
│ │ ├── firebase-hosting-merge.yml # Firebase deploy on merge
│ │ ├── firebase-hosting-pull-request.yml # Firebase preview deploys for PRs
│ │ ├── prek-audit.yml # prek audit workflow
│ │ ├── prek-manual.yml # Manual prek workflow
│ │ ├── prek.yml # Standard prek workflow
│ │ └── super-linter.yml # Super-linter workflow
│ ├── CODEOWNERS # Code ownership rules
│ ├── dependabot.yml # Dependabot configuration
│ └── FUNDING.yml # Sponsorship links
├── src/
│ ├── _data/ # Site-wide data files
│ │ ├── build.js # Build metadata injected into templates
│ │ └── levels.json # XP level definitions for gamification
│ │ ├── levels.json # XP level definitions for gamification
│ │ └── site.js # Global site metadata
│ ├── _includes/ # Reusable Nunjucks templates
│ │ ├── bio.njk # Individual developer profile layout
│ │ ├── footer.njk # Site footer wrapper
│ │ ├── footer-details.njk # Footer content (links, credits)
│ │ ├── game-modal.njk # Modal overlay for mini-games
│ │ ├── game-stats.njk # In-game XP / stats display
│ │ ├── github-ribbon.njk # "Fork me on GitHub" ribbon include
│ │ ├── header.njk # Site header wrapper
│ │ ├── header-details.njk # Header content (nav, theme toggle)
│ │ ├── layouts/
│ │ │ └── base.njk # Base page layout wrapper
│ │ ├── matrix-overlay.njk # Matrix rain easter egg overlay
│ │ ├── seo-meta.njk # SEO/Open Graph metadata tags
│ │ ├── scripts.njk # JS <script> tags included by footer
│ │ ├── skills-list.njk # Renders a developer's skills/languages
│ │ ├── system-log.njk # Scrolling system-log UI element
Expand All @@ -354,36 +361,42 @@ NextCommunity.github.io/
│ │ │ ├── tailwind-input.css # Tailwind CSS entry point
│ │ │ └── tailwind.css # Generated Tailwind CSS output
│ │ ├── img/
│ │ │ ├── github-fork-me.png # GitHub ribbon image asset
│ │ │ └── next.jpeg # Site logo / avatar image
│ │ └── js/
│ │ ├── eggs.js # Easter egg interactions
│ │ ├── phaser.bundle.js # Generated Phaser bundle
│ │ ├── phaser-init.js # Phaser game engine bootstrap
│ │ ├── script.js # Core interactivity & XP system
│ │ └── games/ # Mini-game modules
│ │ ├── code-breaker.js
│ │ ├── code-breaker.js # Code puzzle mini-game
│ │ ├── config.js # Shared game constants & CDN URL
│ │ ├── dev-duel.js
│ │ ├── dev-duel.js # Reflex mini-game
│ │ ├── game-manager.js # Game lifecycle (load/create/destroy)
│ │ └── space-invaders.js
│ │ └── space-invaders.js # Shooter mini-game
│ ├── users/ # 👈 Developer profile YAML files
│ │ ├── users.json # Eleventy data file aggregating YAMLs
│ │ ├── jbampton.yaml
│ │ └── ... # One <github-username>.yaml per dev
│ ├── games.njk # Games page template
│ └── index.njk # Homepage template
│ ├── index.njk # Homepage template
│ ├── robots.njk # robots.txt template
│ └── sitemap.njk # XML sitemap template
├── .editorconfig # Editor formatting rules
├── .eleventy.js # Eleventy configuration
├── .firebaserc # Firebase project alias config
├── .gitattributes # Git text normalization rules
├── .gitignore # Git ignored files
├── .npmrc # npm configuration
├── .pre-commit-config-audit.yaml # prek audit config
├── .pre-commit-config.yaml # prek hooks config
├── LICENSE # Project license
├── biome.json # Biome formatter / linter config
├── firebase.json # Firebase Hosting configuration
├── package-lock.json # Locked npm dependency versions
├── package.json # Node.js dependencies & scripts
├── postcss.config.js # PostCSS / Tailwind build config
├── pyproject.toml # Python tooling config for prek/uv
├── uv.lock # Locked Python dev dependencies
└── README.md # This documentation
```

Expand Down
Loading