Conversation
… framework badges
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the Saucebase documentation site to improve onboarding instructions (especially for AI coding agents) and to enhance the module catalog UI by visually indicating framework compatibility.
Changes:
- Expanded
for-agents.mdwith clearer prerequisite checks, setup-screen flow, and post-setup verification guidance. - Added per-module
frameworksmetadata and updated the module card UI/CSS to render Vue/React framework badges. - Improved installation docs with an agent-oriented prompt and added a warning about SQLite limitations vs MySQL requirements.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| static/for-agents.md | Expanded agent setup guidance, including dependency installation guidance and post-setup verification steps. |
| src/data/modules.json | Added frameworks metadata, adjusted module dependencies, and expanded the module catalog entries. |
| src/components/ModuleCard.tsx | Render framework badges based on a new frameworks prop. |
| src/components/ModuleCard.module.css | Added styling for framework badges (including dark theme variants). |
| docs/getting-started/installation.md | Updated agent copy/paste prompt and added SQLite limitation guidance recommending MySQL for full functionality. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+9
to
+10
| - If it does not, verify that `php`, `composer`, the Laravel installer CLI (`laravel`), and `node` are available. | ||
| - If any are missing, use `php.new` to install them using the correct platform command below. |
Comment on lines
+93
to
+95
| - Read `frontend.json` to detect the active framework before writing any frontend code. | ||
| - Run `php artisan modules:list` to see which modules are installed. | ||
| - If the Auth module was installed: the admin panel is at `/admin` with default credentials `chef@saucebase.dev` / `secretsauce`. Ask the user to verify it loads. |
Comment on lines
150
to
158
| modules/auth/resources/js/ | ||
| ├── pages/ | ||
| ├── components/ | ||
| └── layouts/ | ||
| ``` | ||
|
|
||
| Do not create `vue/` or `react/` subdirectories — those exist only in the Saucebase source repository for contributors, not in installed projects. | ||
|
|
||
| ## Where to Put Files | ||
| ### Where to Put Files | ||
|
|
Comment on lines
+31
to
34
| I'm building a new application with Saucebase — a modular Laravel SaaS starter kit. | ||
|
|
||
| Read https://saucebase-dev.github.io/docs/for-agents.md for the project conventions, structure, and patterns. Treat it as the source of truth for how to add features, where files belong, and what commands to run. | ||
| Fetch and follow the instructions from https://saucebase-dev.github.io/docs/for-agents.md Treat the returned Markdown as the source of truth for how to install, set up, and build with Saucebase in this session. | ||
| ``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request introduces framework badges for modules and expands the module catalog with new entries and guidance for both users and AI coding agents. The changes enhance the documentation for installation and setup, improve the developer and agent onboarding experience, and update the UI to visually indicate framework compatibility for each module.
Module Catalog and UI Enhancements:
frameworksproperty to module definitions inmodules.json, and updated theModuleCardcomponent and CSS to display framework badges (Vue, React) for each module. [1] [2] [3] [4] [5]Documentation and Agent Guidance Improvements:
for-agents.mdto provide comprehensive agent instructions: improved dependency checks, added platform-specific install commands usingphp.new, detailed the setup screen process, and clarified when agents should write frontend code. [1] [2]Dependency and Data Updates:
These changes improve the clarity, onboarding experience, and extensibility of the Saucebase project for both developers and AI coding agents.