Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
174 commits
Select commit Hold shift + click to select a range
6c487ae
Initial commit with new theme, updated nuxt, updated content, nuxt UI
danpastori Oct 17, 2025
bb8dfb0
Update package manager version in package.json from [email protected] to yar…
jaydrogers Oct 20, 2025
e7fe225
Update .env.example with local development settings for Nuxt application
jaydrogers Oct 20, 2025
1ead297
Update NUXT_SITE_URL in .env.example for local development
jaydrogers Oct 20, 2025
d6dc783
Add .nvmrc file to specify Node.js version 22
jaydrogers Oct 20, 2025
208bb6e
Enhance documentation site with color mode configuration and update R…
danpastori Oct 20, 2025
28e1519
Merge branch '280-create-a-frankenphp-variation' into feature/280-pr-…
jaydrogers Oct 20, 2025
5e7df49
Moved and updatd for cloudflare build
danpastori Oct 20, 2025
5c81a90
Merge branch 'feature/280-pr-docs-update' of github.com:serversideup/…
danpastori Oct 20, 2025
fb7973d
Update installation documentation to comment out links for CLI, FPM, …
danpastori Oct 20, 2025
689308d
Update site name and SEO metadata to reflect PHP Docker Images project
jaydrogers Oct 20, 2025
a46604e
Update GitHub links in app configuration to point to the serversideup…
jaydrogers Oct 20, 2025
21a93de
Enhance README with additional power user tips and clarify Nuxt Conte…
jaydrogers Oct 20, 2025
66d2a8b
Update app configuration to change footer credits and update external…
jaydrogers Oct 20, 2025
df6159f
Update app configuration to change footer link to a subscription page…
jaydrogers Oct 20, 2025
9263046
Clarify icon usage in README by specifying the format for icon names …
jaydrogers Oct 20, 2025
537f483
Remove navigation icons from the introduction, comparison, and usage …
jaydrogers Oct 20, 2025
dfaee8b
Update app configuration to change aria-labels for external links to …
jaydrogers Oct 20, 2025
f709966
Add MCP server configuration for Nuxt UI
jaydrogers Oct 20, 2025
15d0a94
Update Nuxt configuration and app settings to reflect new PHP Docker …
jaydrogers Oct 20, 2025
39ac348
Enhance README by adding a new section on components, detailing the u…
jaydrogers Oct 20, 2025
c41003b
Remove the usage documentation file to streamline content and focus o…
jaydrogers Oct 20, 2025
5434e68
Refactor installation documentation to streamline content and enhance…
jaydrogers Oct 20, 2025
ed96808
Update description of serversideup/php Docker images to emphasize the…
jaydrogers Oct 21, 2025
9173e2e
Remove outdated essentials documentation files to streamline content …
jaydrogers Oct 21, 2025
f0902f8
Add custom icon collections to Nuxt configuration and introduce new f…
jaydrogers Oct 21, 2025
8572a57
Add pageCard configuration to app settings with styled slots for lead…
jaydrogers Oct 21, 2025
b3e1932
Update icon references and section titles in getting started document…
jaydrogers Oct 21, 2025
dd732bd
Update documentation to replace 'NGINX Unit variation' with 'FrankenP…
jaydrogers Oct 21, 2025
ee97bf7
Remove mcp.json configuration file to streamline project structure an…
jaydrogers Oct 21, 2025
40b9ab7
Add AGENTS.md to outline skills and development guidelines for mainta…
jaydrogers Oct 21, 2025
84aa0b6
Add comprehensive AGENTS.md documentation outlining AI agent guidelin…
jaydrogers Oct 21, 2025
44c04d1
Make video full width. Fixes #582
jaydrogers Oct 21, 2025
3999b08
Add LeadP component with template and script setup for improved text …
jaydrogers Oct 21, 2025
e46b0bc
Update feature icons in documentation for improved visual consistency…
jaydrogers Oct 21, 2025
2b4fe4a
Add container-layers.png image to documentation for enhanced visual r…
jaydrogers Oct 21, 2025
8571f50
Enhance installation documentation and introduce container concepts f…
jaydrogers Oct 21, 2025
eaa9583
Add code icon mappings for Docker-related files in app configuration …
jaydrogers Oct 21, 2025
7d8633a
Add syntax highlighting configuration for documentation to support ad…
jaydrogers Oct 21, 2025
2cc3344
Enhance app configuration by adding a new link for 'Professional Help…
jaydrogers Oct 21, 2025
14113bf
Added favicon, Fixes #580
jaydrogers Oct 21, 2025
eb33bfe
Enhance icon configuration by adding 'services' collection and updati…
jaydrogers Oct 21, 2025
2f923ae
Update installation documentation for PHP Docker images: added 'Tag' …
jaydrogers Oct 21, 2025
e2631ac
Update getting started documentation for PHP Docker images: enhanced …
jaydrogers Oct 21, 2025
a2285a7
Fix minor wording in installation documentation for PHP Docker images…
jaydrogers Oct 21, 2025
d3f8bfe
Enhance installation documentation for PHP Docker images by adding a …
jaydrogers Oct 21, 2025
b88d9f7
Update installation documentation for PHP Docker images by adding ter…
jaydrogers Oct 22, 2025
2f68765
Add icon mapping for 'Terminal' in app configuration to improve docum…
jaydrogers Oct 22, 2025
342c4b7
Remove redundant 'Volume' definition from installation documentation …
jaydrogers Oct 22, 2025
f078b4b
Add VSCode settings to exclude specific directories from search resul…
jaydrogers Oct 22, 2025
f3a13e4
Update app configuration to include Kubernetes deployment icons and e…
jaydrogers Oct 22, 2025
b8b4864
Add Kubernetes and NGINX icons to services collection for improved do…
jaydrogers Oct 22, 2025
a7ecb35
Refactor navigation data handling in documentation layout to improve …
jaydrogers Oct 22, 2025
ae84eb4
Add various SVG and PNG logos to documentation for improved visual co…
jaydrogers Oct 22, 2025
a9c97a2
Enhance documentation for PHP Docker images by adding notes on unpriv…
jaydrogers Oct 22, 2025
029b69f
Update installation documentation to replace references from 'Contain…
jaydrogers Oct 22, 2025
b9990df
Refactor button syntax in getting started documentation for consisten…
jaydrogers Oct 22, 2025
c12161b
Update button syntax in getting started documentation for consistency…
jaydrogers Oct 22, 2025
8bcffda
Refactor button syntax in installation documentation for consistency,…
jaydrogers Oct 22, 2025
6ee620c
Add 'Choosing an Image' guide to documentation, detailing image selec…
jaydrogers Oct 22, 2025
4d208e1
Expand 'Choosing an Image' documentation to include detailed descript…
jaydrogers Oct 22, 2025
2ef19ef
Add comprehensive 'Default Configurations' documentation for PHP Dock…
jaydrogers Oct 22, 2025
5fec045
Add upgrade guide documentation for Docker PHP images, detailing vers…
jaydrogers Oct 22, 2025
f9b01c5
Add changelog documentation for Docker PHP images, providing an overv…
jaydrogers Oct 22, 2025
364ee7b
Add 'About Us' documentation for Docker PHP images, introducing the p…
jaydrogers Oct 22, 2025
46a830e
Add contributing documentation for Docker PHP images, outlining guide…
jaydrogers Oct 22, 2025
9751cae
Add CLI documentation for the PHP Docker image, detailing usage, feat…
jaydrogers Oct 22, 2025
4fcdae3
Add FPM documentation for the PHP Docker image, detailing usage, conf…
jaydrogers Oct 22, 2025
f5fef7c
Add FPM-Apache documentation for the PHP Docker image, detailing its …
jaydrogers Oct 22, 2025
89f82f9
Add custom NGINX configuration icon to app configuration, enhancing v…
jaydrogers Oct 22, 2025
a40f289
Enhance installation documentation for PHP Docker images by adding de…
jaydrogers Oct 22, 2025
893671d
Refine installation documentation for PHP Docker images by removing u…
jaydrogers Oct 22, 2025
e43e6b3
Add navigation configuration files for Laravel, WordPress, Platforms,…
jaydrogers Oct 22, 2025
281b058
Add documentation for NGINX Unit variation, noting its archival statu…
jaydrogers Oct 22, 2025
2578bfb
Add container basics documentation, introducing key concepts of conta…
jaydrogers Oct 22, 2025
ad01f07
Add navigation entry for Orchestrators in deployment documentation, i…
jaydrogers Oct 22, 2025
a870c2e
Update FPM-Apache documentation to include SSL configuration and addi…
jaydrogers Oct 22, 2025
f15e0b8
Add new SVG and PNG images for documentation, including container ini…
jaydrogers Oct 22, 2025
06154ee
Fix documentation links for S6 Overlay and health checks, ensuring ac…
jaydrogers Oct 22, 2025
fe6f346
Add command reference documentation for Docker PHP image, detailing a…
jaydrogers Oct 22, 2025
fe4f6b3
Add environment variable specification documentation for Docker PHP i…
jaydrogers Oct 22, 2025
a83a85d
Add navigation configuration for Advanced Guides in documentation, en…
jaydrogers Oct 22, 2025
a1fa608
Add Laravel automation, task scheduler, queue, horizon, and reverb do…
jaydrogers Oct 22, 2025
df7ac7a
Add WordPress optimization documentation for Docker PHP images, detai…
jaydrogers Oct 22, 2025
7fe6f02
Add section on migrating from official PHP images in installation doc…
jaydrogers Oct 22, 2025
9aff799
Enhance Laravel documentation by adding tips for using Spin Pro for T…
jaydrogers Oct 22, 2025
d8228eb
Add FPM-NGINX documentation, detailing usage, configuration, and perf…
jaydrogers Oct 22, 2025
fe997be
Enhance documentation for PHP Docker images by adding optional 'redir…
danpastori Oct 22, 2025
1bf90e8
Fixed OG Images
danpastori Oct 22, 2025
ce7f643
Add migration guide from official PHP images to serversideup/php, det…
jaydrogers Oct 22, 2025
ae1dfb4
Add 'diff' language support to Nuxt configuration, enhancing syntax h…
jaydrogers Oct 22, 2025
26c9137
Merge branch 'feature/280-pr-docs-update' of github.com:serversideup/…
jaydrogers Oct 22, 2025
44d3626
Added about
danpastori Oct 22, 2025
2b662be
Merge branch 'feature/280-pr-docs-update' of github.com:serversideup/…
danpastori Oct 22, 2025
2c1f2c4
Add new components and enhance existing documentation for improved us…
danpastori Oct 23, 2025
734c9b1
Update GitHub link in app configuration to point to the correct Docke…
jaydrogers Oct 23, 2025
d48b8b3
Update Laravel task scheduler, queue, horizon, and reverb documentati…
jaydrogers Oct 23, 2025
a840bd1
Enhance navigation processing in documentation layout by adding funct…
jaydrogers Oct 23, 2025
2ceda24
Update social media links in documentation components to reflect the …
jaydrogers Oct 23, 2025
257c961
Add a new section in installation documentation to guide users from D…
jaydrogers Oct 23, 2025
8b074f2
Update documentation to reflect deprecation of NGINX Unit, replacing …
jaydrogers Oct 23, 2025
d7c84d6
Update app components to change background color from neutral to blac…
jaydrogers Oct 23, 2025
2f58898
Update FollowAlong component to reflect rebranding of Twitter to 'X',…
jaydrogers Oct 23, 2025
1628536
Update documentation to change background color from neutral to black…
jaydrogers Oct 23, 2025
5e4ebcb
Add documentation for installing additional PHP extensions in Docker …
jaydrogers Oct 23, 2025
6d78f9b
Add a tip in the documentation encouraging users to support our work …
jaydrogers Oct 23, 2025
8c844c0
Update documentation for FrankenPHP to include a warning about known …
jaydrogers Oct 23, 2025
e0fa43e
Update documentation for FPM variations to include enhanced tips link…
jaydrogers Oct 23, 2025
79dc231
Update documentation for installing additional PHP extensions to incl…
jaydrogers Oct 23, 2025
4dba9d5
Link Unit warning
jaydrogers Oct 23, 2025
8289039
Updated reference on entrypoint script
jaydrogers Oct 23, 2025
fdf8342
Unit archive clarification
jaydrogers Oct 24, 2025
89c44d1
Remove CADDY_GLOBAL_LOG_LEVEL because it doesn't exists. Fixes https:…
jaydrogers Oct 24, 2025
c95e4ab
Enhance migration documentation by removing outdated section on defau…
jaydrogers Oct 24, 2025
96a1132
Fix typos in documentation: correct "confiugration" to "configuration…
jaydrogers Oct 28, 2025
f6607b7
Add structured comments to Caddyfile for improved readability and org…
jaydrogers Oct 28, 2025
ea324bf
Update Apache configuration to support customizable HTTP and HTTPS po…
jaydrogers Oct 28, 2025
641f8fb
Introduce environment variables for customizable Apache HTTP and HTTP…
jaydrogers Oct 28, 2025
b8d4b7e
Update health check messages for Apache and NGINX to improve clarity …
jaydrogers Oct 28, 2025
be547d1
Refactor Apache and NGINX configurations to utilize environment varia…
jaydrogers Oct 28, 2025
750363b
Update health check command in Dockerfile to use CADDY_HTTP_PORT envi…
jaydrogers Oct 28, 2025
9c61c45
Add SSL full configuration template for NGINX and update entrypoint s…
jaydrogers Oct 28, 2025
a34c611
Update SSL generation script to improve clarity in Caddy Auto HTTPS n…
jaydrogers Oct 28, 2025
cf1c66f
Refactor Dockerfile to create and set permissions for Composer cache …
jaydrogers Oct 28, 2025
f0e9ec0
Enhance file permission settings in Docker image by including /config…
jaydrogers Oct 28, 2025
2c2cf78
Fixed syntax error and removed redundant code
jaydrogers Oct 28, 2025
d05acf7
Refactor Caddyfile configurations to replace 'app-common' with 'php-a…
jaydrogers Oct 29, 2025
73ab6ea
Enhance SSL generation script to include healthcheck SSL keypair crea…
jaydrogers Oct 29, 2025
aec64b5
Refactor SSL generation script to improve logic for existing certific…
jaydrogers Oct 29, 2025
84888cb
Enhance Apache health check script to conditionally log HTTP status c…
jaydrogers Oct 30, 2025
33a302e
Refactor SSL handling by removing validation from webserver config sc…
jaydrogers Oct 30, 2025
5037ba2
Update healthcheck SSL configuration and paths in Docker setup. This …
jaydrogers Oct 30, 2025
50f630c
fix: Set SSL_PRIVATE_KEY_FILE to proper name on FrankenPHP
jaydrogers Oct 30, 2025
6af0abc
Add SSL configuration documentation for Docker PHP images
jaydrogers Oct 30, 2025
b4abf11
Add reverse proxy SSL zero downtime image for documentation
jaydrogers Oct 30, 2025
644dd4f
Revise documentation for 'serversideup/php' to highlight its advantag…
jaydrogers Oct 31, 2025
4c922f2
Cleaned up title
jaydrogers Oct 31, 2025
ab7363c
Add 'Getting Help' documentation to provide users with resources for …
jaydrogers Oct 31, 2025
25d10e6
Update installation documentation to clarify definitions of 'Image' a…
jaydrogers Oct 31, 2025
15f68b4
Add target="_blank" attribute to external link in app.vue for improve…
jaydrogers Oct 31, 2025
c56a4e4
Update code block syntax in documentation from 'yaml' to 'yml' for co…
jaydrogers Oct 31, 2025
c1399e4
Add common issues troubleshooting guide for Docker images, covering p…
jaydrogers Oct 31, 2025
8c59bb8
Update PHP image version in documentation from 8.3 to 8.4 for Docker …
jaydrogers Oct 31, 2025
ebe579f
Add documentation for using S6 Overlay with Docker PHP images, explai…
jaydrogers Oct 31, 2025
41537a0
Add documentation for native Docker health checks in Laravel, detaili…
jaydrogers Oct 31, 2025
3bd3cf7
Add migration guide from v2 to v3 for serversideup/php images, detail…
jaydrogers Oct 31, 2025
7fdf21b
Refactor health check documentation for Laravel in Docker Compose exa…
jaydrogers Oct 31, 2025
170de94
Add comprehensive documentation on container fundamentals, including …
jaydrogers Oct 31, 2025
cc5c1ea
Update container basics documentation to reflect the change from PHP …
jaydrogers Oct 31, 2025
4867bf7
Add documentation for packaging PHP applications for deployment, deta…
jaydrogers Oct 31, 2025
dfea2cd
Update Docker Compose code block syntax in Laravel documentation to u…
jaydrogers Oct 31, 2025
3652933
Update migration guide to reflect the change from 'docker-compose.yml…
jaydrogers Oct 31, 2025
0085c82
Update health check documentation for Laravel to consistently use 'co…
jaydrogers Oct 31, 2025
2423c65
Add documentation on understanding file permissions in PHP + Docker, …
jaydrogers Oct 31, 2025
2732741
Refactor file permissions documentation for PHP + Docker, improving c…
jaydrogers Oct 31, 2025
2be9f01
Update SSL configuration documentation to replace 'docker-compose.yml…
jaydrogers Oct 31, 2025
2191083
Add comprehensive guide on transitioning from development to producti…
jaydrogers Oct 31, 2025
a97c210
Update migration guide to replace 'docker-compose.yml' with 'compose.…
jaydrogers Oct 31, 2025
bd65f8b
Fix formatting in packaging documentation by adding a space after the…
jaydrogers Oct 31, 2025
464c25f
Add documentation on adding custom start-up scripts in Docker PHP. In…
jaydrogers Nov 3, 2025
c73cd4b
Add documentation for changing common PHP settings in Docker. Include…
jaydrogers Nov 3, 2025
147c0eb
Add new host icons and update Nuxt configuration to include them. Int…
jaydrogers Nov 4, 2025
ef0a0fb
Add comprehensive documentation on choosing a hosting provider for co…
jaydrogers Nov 4, 2025
e3ccdb0
Simplified examples on FPM
jaydrogers Nov 4, 2025
8395ba3
Add health check information for Laravel in FPM-Apache and FPM-NGINX …
jaydrogers Nov 4, 2025
d163b13
Update environment variable documentation to replace `CADDY_APP_PUBLI…
jaydrogers Nov 4, 2025
8a76037
Update Dockerfile to replace `CADDY_APP_PUBLIC_PATH` with `CADDY_SERV…
jaydrogers Nov 4, 2025
5151886
A-Z the caddy variables
jaydrogers Nov 4, 2025
60d4a79
Add comprehensive documentation for the FrankenPHP variation of the s…
jaydrogers Nov 4, 2025
833a867
Add documentation for configuring Laravel Octane with Docker, includi…
jaydrogers Nov 4, 2025
3b67331
Update links in image variations documentation for consistency and im…
jaydrogers Nov 4, 2025
bc4211d
Reintroduce redirect logic for page navigation in [...slug].vue to en…
jaydrogers Nov 4, 2025
01c5466
Only navigate after mount. This allows us to build the site
danpastori Nov 4, 2025
bfd396b
Update environment variable documentation to include `frankenphp` in …
jaydrogers Nov 4, 2025
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
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,5 @@ package.json
yarn.lock
node_modules
php-versions.yml
*.tmp
*.tmp
/docs/_OLD_
7 changes: 7 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"search.exclude": {
"**/.nuxt": true,
"**/node_modules": true,
"**/dist": true
}
}
File renamed without changes.
11 changes: 9 additions & 2 deletions docs/.env.example
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
# Used for Nuxt SEO
NUXT_SITE_URL=https://localhost:3000
NUXT_SITE_NAME="Docker PHP - Server Side Up"
NUXT_SITE_ENV="development"

# Used for Nuxt App configuration
PLAUSIBLE_ENABLED=false
BASE_PATH=http://localhost:3000/open-source/docker-php
NUXT_APP_BASE_URL=/open-source/docker-php
TOP_LEVEL_DOMAIN=http://localhost:3000
BASE_PATH=http://localhost:3000/open-source/docker-php
TOP_LEVEL_DOMAIN=http://localhost:3000
27 changes: 23 additions & 4 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -1,8 +1,27 @@
node_modules
*.log*
# Nuxt dev/build outputs
.output
.data
.nuxt
.nitro
.cache
.output
.env
dist

# Node dependencies
node_modules

# Logs
logs
*.log

# Misc
.DS_Store
.fleet
.idea

# Local env files
.env
.env.*
!.env.example

# VSC
.history
1 change: 0 additions & 1 deletion docs/.npmrc
Original file line number Diff line number Diff line change
@@ -1,2 +1 @@
shamefully-hoist=true
strict-peer-dependencies=false
2 changes: 1 addition & 1 deletion docs/.nvmrc
Original file line number Diff line number Diff line change
@@ -1 +1 @@
20
22
187 changes: 187 additions & 0 deletions docs/AGENTS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,187 @@
# AI Agent Guidelines for Documentation

You are a highly skilled technical writer and PHP system administrator. You are an expert at breaking down complex technical concepts into easy to understand language. You also carry a significant experience in structuring open source documentation to make it easy for others to understand, modify, and contribute to the project.

## Project Context

This is the documentation site for **serversideup/php** - production-ready Docker images optimized for PHP applications (especially Laravel). Looking at the project root, you'll see the following directories:
```
docs/ # Documentation and Marketing site
scripts/ # Scripts used for image building and deployment
src/ # Source code for the PHP Docker images
```
### Key Technologies in the docs/ directory
- **Nuxt 4** - Vue-based static site generator
- **Nuxt Content** - File-based CMS for markdown documentation
- **Nuxt UI** - Component library for the Nuxt 4 application
- **TailwindCSS** - Utility-first CSS framework

## Documentation Structure

The documentation site (located in the docs/ directory) follows this organization:

```
app/ # Nuxt app configuration
content/ # Markdown documentation
public/ # Static assets
server/ # Server-side routes for the Nuxt application
```

Important note: This application is 100% static and does not require a database or server-side rendering. It is a simple Nuxt 4 application that uses the Nuxt Content module to build the documentation site. The site is then deployed to a static hosting provider like CloudFlare Pages.


## Writing Guidelines

### 1. **Tone and Voice**
- Use clear, conversational language that's professional but approachable
- Write for developers of varying skill levels - beginners to advanced
- Avoid jargon when possible; when technical terms are necessary, explain them
- Use active voice and second person ("you" instead of "one" or "the user")
- Be friendly and approachable, but not too casual.

### 2. **Content Structure**
- Start with the "why" before the "how"
- Use clear, descriptive headings that follow a logical hierarchy
- Include practical examples that users can copy and run
- Add callouts (notes, warnings, tips) for important information
- Break up long sections with subheadings, lists, and code blocks

### 3. **Code Examples**
- Always test code examples to ensure they work
- Include comments in complex examples
- Show realistic, production-ready examples when possible
- Specify language syntax highlighting in code blocks
- For Docker examples, use the actual image tags available in the project

### 4. **Markdown Conventions**
- Use ATX-style headers (# ## ###) not underline style
- Use fenced code blocks with language identifiers
- Use relative links for internal documentation
- Use absolute URLs for external resources
- Include alt text for all images

### 5. **Docker-Specific Guidelines**
When documenting Docker concepts:
- Show both Docker CLI and Docker Compose examples
- Explain what environment variables do and their default values
- Include health check examples
- Demonstrate volume mounts with real use cases
- Always specify image tags (never use `:latest`)

### 6. **Laravel-Specific Guidelines**
When documenting Laravel features:
- Reference official Laravel documentation when appropriate
- Show examples using Laravel conventions (Artisan, config, .env)
- Explain automations that the images provide for Laravel
- Document queue, schedule, and Horizon workers properly

## Content Review Checklist

Before considering documentation complete, verify:

- [ ] All code examples are tested and working
- [ ] External links are valid and not broken
- [ ] Spelling and grammar are correct
- [ ] Headings follow logical hierarchy (H1 → H2 → H3)
- [ ] Code blocks have appropriate syntax highlighting
- [ ] Complex concepts include examples or diagrams
- [ ] Callouts (notes/warnings) are used appropriately
- [ ] Cross-references to other docs use relative links
- [ ] Docker image versions match what's actually available
- [ ] Content is accurate to the current version

## Common Patterns

### Callout Boxes
Use Markdown callouts for important information:
```markdown
::note
Here's some additional information.
::

::tip
Here's a helpful suggestion.
::

::warning
Be careful with this action as it might have unexpected results.
::

::caution
This action cannot be undone.
::
```

### Code Blocks
Use code blocks to display multi-line code snippets with syntax highlighting. Code blocks are essential for presenting code examples clearly. When writing a code-block, you can specify a filename that will be displayed on top of the code block. An icon will be automatically displayed based on the extension or the name. Filenames help users understand the code's location and purpose within a project. To highlight lines of code, add {} around the line numbers you want to highlight. Line highlighting is useful for focusing users on important parts of code examples.

```markdown
Here's how to configure PHP-FPM with custom settings:

\`\`\`ts [nuxt.config.ts]{4-5}
export default defineAppConfig({
ui: {
icons: {
copy: 'i-lucide-copy',
copyCheck: 'i-lucide-copy-check'
}
}
})
\`\`\`
```

## File Naming Conventions

- Use numbered prefixes for ordered content: `1.index.md`, `2.installation.md`
- Use kebab-case for file names: `these-images-vs-others.md`
- Keep file names concise but descriptive
- Match file names to the primary H1 heading (URL-friendly version)

## When to Ask Questions

Don't guess or assume when:
- Technical accuracy is in question (Docker config, PHP settings, etc.)
- Breaking changes affect existing documentation
- New features need to be documented but requirements are unclear
- Examples might not work across different OS or environments

## Helpful Resources

- [Official Nuxt Content Documentation](https://content.nuxt.com/)
- [Nuxt UI Docs Template](https://docs-template.nuxt.dev/)
- [Docker Best Practices](https://docs.docker.com/develop/dev-best-practices/)
- [Laravel Documentation](https://laravel.com/docs)
- [serversideup/php GitHub Repository](https://github.com/serversideup/docker-php)
- [Write the Docs Style Guide](https://www.writethedocs.org/guide/writing/style-guides/)

## Component Usage

This Nuxt docs site has custom Vue components. Familiarize yourself with:
- `<AppLogo>` - Project logo
- `<Badges>` - Status badges
- `<HeroVideo>` - Video embeds
- `<PageHeaderLinks>` - Navigation
- `<TemplateMenu>` - Template selection

Check `app/components/` directory for available components before creating new ones.

## Testing Changes Locally

To test documentation changes:
```bash
cd docs/
yarn install
yarn dev
```

Browse to http://localhost:3000 to preview changes.

## Remember

- **Users first**: Always consider what the reader needs to accomplish
- **Clarity over cleverness**: Simple, clear language beats fancy technical writing
- **Examples matter**: Show, don't just tell
- **Accuracy is critical**: Wrong documentation is worse than no documentation
- **Open source mindset**: Make it easy for others to contribute and improve

Your goal is to help users succeed with these Docker images quickly and confidently.
13 changes: 12 additions & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Documentation & Static Site, generated with Nuxt Content
This is a documentation site built on top of Nuxt Content (v3).
This is a documentation site built on top of Nuxt Content.

# Docs location
All docs are located in the [./content](./content/docs) folder if you're just looking for the docs in plain text.
Expand Down Expand Up @@ -47,3 +47,14 @@ yarn preview
```

Check out the [deployment documentation](https://nuxt.com/docs/getting-started/deployment) for more information.

# Power User Tips
If you're diving deep into the docs, here are some tips to help you out:

## Components
All components are from the [Nuxt UI](https://ui.nuxt.com/) component library, using the [Nuxt UI Documentation Template](https://docs-template.nuxt.dev).

[View the Nuxt UI Documentation Template components →](https://docs-template.nuxt.dev/essentials/prose-components)

## Icons
All icons are from the [Lucide](https://lucide.dev/icons/) icon set. Use the icon name of `i-lucide-<icon-name>` as the value for the `icon` field in the YAML frontmatter.
Loading
Loading