Add Getting Started overview and refresh docs#21
Merged
Merged
Conversation
Deploying with
|
| Status | Name | Latest Commit | Preview URL | Updated (UTC) |
|---|---|---|---|---|
| ✅ Deployment successful! View logs |
docs | 23ae103 | Commit Preview URL Branch Preview URL |
May 12 2026, 12:47 AM |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR refreshes the “Getting Started” documentation by adding an overview/landing page and simplifying several setup guides to better direct first-time users through installation paths.
Changes:
- Added a new Getting Started → Overview page with navigation cards and linked it in the sidebar.
- Simplified and condensed the System Requirements, Installation, Docker, and Building docs.
- Updated the main Introduction page to point users to the new Getting Started section and tightened wording.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| src/content/docs/index.mdoc | Updates intro wording and simplifies the help section to rely on the new Getting Started overview. |
| src/content/docs/getting-started/index.mdoc | Adds a new Getting Started landing page with link cards to key setup paths. |
| src/content/docs/getting-started/requirements.mdoc | Condenses requirements and updates the stated supported PHP versions/extensions. |
| src/content/docs/getting-started/installation.mdoc | Tweaks web server tab wording and trims cron documentation (notably removing the remote cron section). |
| src/content/docs/getting-started/docker.mdoc | Simplifies Docker guidance and trims post-install steps while keeping the cron example. |
| src/content/docs/getting-started/building.mdoc | Updates PHP prerequisite version and trims the local run guidance. |
| astro.config.mjs | Adds “Overview” link under the Getting Started sidebar group. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+169
to
173
| #### Local Cron Job | ||
|
|
||
| FOSSBilling shows the correct cron command on the installation-complete screen and again in the admin panel. If you need to find it later, go to `Settings` -> `Scheduled Tasks` (`/admin/extension/settings/cron`). | ||
|
|
||
|  |
| {% /aside %} | ||
|
|
||
| After installation, set up the cron job on your host: | ||
|
|
| - **`memory_limit`**: At least `64M`. Increase if you run many modules or have high traffic. | ||
| - **`max_execution_time`**: Default `30` seconds is usually fine. Increase to `45`–`60` on shared hosting if needed. | ||
| - **`allow_url_fopen`**: Set to `On` if you need remote images in PDFs or emails. | ||
| - **Supported Versions**: 8.3, 8.4, or 8.5. |
| {% aside %} | ||
| Make sure you have: | ||
| - PHP 8.2 or newer | ||
| - PHP 8.3 or newer |
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.
No description provided.