[Feature]: Documentation skeleton #103

Closed
opened 2026-02-04 17:38:44 +03:00 by OVERLORD · 3 comments
Owner

Originally created by @alextran1502 on GitHub (Jun 22, 2022).

Feature detail

This issue is for discussing and implementing the skeleton of the content for the documentation site.

This is what I have in mind currently, feel free to copy and add in your ideas, suggestions

Installation Guide

├── x86
│   ├── Bare-metal with docker-compose
│   ├── Portainer
├── Armv7
│   ├── Bare-metal with docker-compose
│   ├── Portainer

Reverse Proxy Guide

├── Nginx
├── Traefik
├── Caddy

Platform

Web

Originally created by @alextran1502 on GitHub (Jun 22, 2022). ### Feature detail This issue is for discussing and implementing the skeleton of the content for the documentation site. This is what I have in mind currently, feel free to copy and add in your ideas, suggestions **Installation Guide** ```bash ├── x86 │   ├── Bare-metal with docker-compose │   ├── Portainer ├── Armv7 │   ├── Bare-metal with docker-compose │   ├── Portainer ``` **Reverse Proxy Guide** ```bash ├── Nginx ├── Traefik ├── Caddy ``` ### Platform Web
Author
Owner

@jrasm91 commented on GitHub (Aug 27, 2022):

Not sure what goes in nginx, but you could probably include steps for nginxproxymanager.

In the docs you could also include troubleshooting steps, common pitfalls, errors, FAQs, and steps for upgrading.

@jrasm91 commented on GitHub (Aug 27, 2022): Not sure what goes in nginx, but you could probably include steps for nginxproxymanager. In the docs you could also include troubleshooting steps, common pitfalls, errors, FAQs, and steps for upgrading.
Author
Owner

@alextran1502 commented on GitHub (Oct 25, 2022):

New skeleton 10/2022

* Overview
	* Why is this app exist (and showcase)?
	* What is the meaning of the logo?
	* Technology stack
	* Support the project

* Installation (Include setup and update)
	* Requirement and Requisite
	* One-step installation
	* Docker-compose installation (Recommended)
	* Portainer using docker-compose
	* Unraid 
 
* Usage Explanation 
	* Common usage case
	* Android background backup

* Mobile App Beta Program
* FAQ
@alextran1502 commented on GitHub (Oct 25, 2022): New skeleton 10/2022 ```bash * Overview * Why is this app exist (and showcase)? * What is the meaning of the logo? * Technology stack * Support the project * Installation (Include setup and update) * Requirement and Requisite * One-step installation * Docker-compose installation (Recommended) * Portainer using docker-compose * Unraid * Usage Explanation * Common usage case * Android background backup * Mobile App Beta Program * FAQ ```
Author
Owner

@alextran1502 commented on GitHub (Nov 22, 2022):

Implemented in docs

@alextran1502 commented on GitHub (Nov 22, 2022): Implemented in `docs`
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: immich-app/immich#103