Simplify v7 installation page to three core sections #10
Conversation
Co-authored-by: qisthidev <[email protected]>
Deploying docs with
|
| Latest commit: |
23c273c
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://0125083d.docs-lst.pages.dev |
| Branch Preview URL: | https://copilot-sub-pr-9.docs-lst.pages.dev |
Co-authored-by: qisthidev <[email protected]>
|
Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details. Warning Firewall rules blocked me from connecting to one or more addresses (expand for details)I tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
There was a problem hiding this comment.
Pull request overview
This PR significantly simplifies the v7 installation documentation by condensing it from 462 to 117 lines, removing verbose prerequisites, PHP extension details, and redundant troubleshooting sections while reorganizing content into three streamlined installation options.
Key changes:
- Restructured documentation into three clear installation paths: Starter Kit, Package Installation (7.x dev branch), and Local Development Setup
- Removed detailed PHP requirements, extension installation instructions, and troubleshooting sections
- Consolidated Docker configuration and removed duplicate content
Reviewed changes
Copilot reviewed 1 out of 2 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| src/app/v7/installation/page.md | Complete restructure of installation guide with simplified options and removal of verbose technical details |
| .gitignore | Added package-lock.json to ignore list for consistency with project's package manager preference |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| Start the development environment: | ||
| ```bash | ||
| # Start the development environment | ||
| docker compose up -d | ||
|
|
||
| # Install Laravolt (if not already installed) | ||
| docker compose exec php composer require laravolt/laravolt | ||
| docker compose exec php php artisan laravolt:install | ||
| docker compose exec php php artisan migrate:fresh | ||
| docker compose exec php php artisan laravolt:admin | ||
| ``` |
There was a problem hiding this comment.
Important environment configuration information was removed. Users setting up Docker won't know that they need to configure their .env file with Redis and Mailpit settings (REDIS_HOST=redis, MAIL_HOST=mailserver, etc.) for these services to work properly. Consider adding a brief note or link to environment configuration requirements.
| Start the development environment: | ||
| ```bash | ||
| # Start the development environment | ||
| docker compose up -d | ||
|
|
||
| # Install Laravolt (if not already installed) | ||
| docker compose exec php composer require laravolt/laravolt | ||
| docker compose exec php php artisan laravolt:install | ||
| docker compose exec php php artisan migrate:fresh | ||
| docker compose exec php php artisan laravolt:admin | ||
| ``` | ||
|
|
||
| ### Access Points | ||
|
|
||
| Access points: | ||
| - **Main application**: http://localhost:8080 | ||
| - **Email testing (Mailpit)**: http://localhost:8025 | ||
|
|
There was a problem hiding this comment.
The removed Docker development commands section contained useful information for developers about how to run commands inside the Docker container (e.g., docker compose exec php composer install, docker compose exec php php artisan migrate). New users following Option 1 who use Docker won't know how to run the necessary setup commands inside the container. Consider adding at least a brief mention of how to execute commands in the Docker environment.
| php artisan migrate:fresh | ||
| ``` | ||
|
|
||
| ### Step 4: Create Admin User | ||
|
|
||
| Add a user with admin role: | ||
|
|
||
| ```bash | ||
| # Interactive command | ||
| php artisan laravolt:admin | ||
|
|
||
| # Or specify details directly | ||
| php artisan laravolt:admin Administrator [email protected] secret | ||
| ``` |
There was a problem hiding this comment.
The installation instructions in Option 1 (lines 22-24) show running migrations and creating an admin user, but these commands assume the user is running them locally. However, if a user follows Option 3 and sets up Docker first, they would need to prefix these commands with docker compose exec php. The flow between sections could be clearer about when to use which approach, or at minimum, a note should be added about running commands in the Docker environment if that's the chosen setup.
| ### Quick Start | ||
|
|
||
| Create a `compose.yaml` file in your project root: | ||
| For a complete development environment with Redis and email testing, create a `docker-compose.yml` file in your project root: |
There was a problem hiding this comment.
The Docker Compose filename is inconsistent. The section title says "docker-compose.yml" but the old code had both "compose.yaml" and "docker-compose.yaml". For consistency and following Docker Compose's modern conventions, consider using "compose.yaml" (which is the newer standard) or "docker-compose.yml" throughout. Currently, line 58 says "docker-compose.yml" in the text.
| For a complete development environment with Redis and email testing, create a `docker-compose.yml` file in your project root: | |
| For a complete development environment with Redis and email testing, create a `compose.yaml` file in your project root: |
Condensed the v7 installation documentation from 462 to 117 lines by removing verbose prerequisites, PHP extension details, and redundant troubleshooting sections.
Changes
composer create-project laravolt/laravel-starter-kit --prefer-dist example-appcomposer require laravolt/laravolt:7.x-dev→php artisan laravolt:installRemoved:
Migration note
Users needing PHP extension details can refer to Laravel's official documentation or Composer's platform requirements check (
composer check-platform-reqs).💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.