Skip to content

docs(install): correct npm source, document peer deps, fix tailwind path - #3

Merged
maherelgamil merged 1 commit into
mainfrom
docs/installation-update
May 28, 2026
Merged

docs(install): correct npm source, document peer deps, fix tailwind path#3
maherelgamil merged 1 commit into
mainfrom
docs/installation-update

Conversation

@maherelgamil

Copy link
Copy Markdown
Contributor

Summary

  • Fix description of monorail:install — says it installs from "GitHub Packages", but monorailphp is published to the npm registry.
  • Document peer dependencies introduced in v0.2.0. npm 7+ auto-installs them; pnpm / yarn with strict peer resolution need an explicit install command (listed in the docs).
  • Unify Tailwind @source path with the Vite input + config('monorail.assets.js_entry') — all three now point at node_modules/monorailphp/.... Previously the manual-install snippet pointed at vendor/monorail/monorail/..., which didn't match the other paths and used the old composer name.

Test plan

  • Fresh Laravel + Inertia app: `composer require monorailphp/monorail` then `php artisan monorail:install` — verify the description matches what actually happens.
  • pnpm consumer follows the new "Peer dependencies" block — `npm run dev` succeeds without ERESOLVE.
  • Manual-install path renders an admin page using the `node_modules` source.

- Update install command description: npm registry, not GitHub Packages
- Add 'Peer dependencies' section explaining auto-install vs explicit install
- Manual-install tailwind @source now uses node_modules path (matches the
  vite + js_entry paths), so all three references point at one location
@maherelgamil
maherelgamil merged commit 6585334 into main May 28, 2026
9 checks passed
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