starred/koel-koel

Fork 0

mirror of https://github.com/koel/koel.git synced 2026-04-25 08:46:00 +03:00

[GH-ISSUE #1767] Improve Documentation for installation for web development #974

New issue

Closed

opened 2026-02-26 02:34:48 +03:00 by kerem · 2 comments

kerem commented

2026-02-26 02:34:48 +03:00

Owner

Originally created by @lexuanangel on GitHub (May 27, 2024).
Original GitHub issue: https://github.com/koel/koel/issues/1767

Description
A clear and concise description of the new feature or improvement.
Hello! I would like to write documentation/tutorial to help new developers get from installation to use of koel on the following operating systems: Windows, and MacOS. I had reviewed the existing documentation (Official Documentation), but while I was going through it, I struggled to follow it on MacOS and had to look to outside resources to see how to install and use the product. This experience pushed me to want to write documentation/tutorial that could help create clarity and be able to ease people into use of the product.

Example
For example, clarifying how to build from source with MacOS because the commands will differ and being explicit on how to type the commands in. In comparison, the current instructions do not specify for MacOS.

Originally created by @lexuanangel on GitHub (May 27, 2024). Original GitHub issue: https://github.com/koel/koel/issues/1767 **Description** A clear and concise description of the new feature or improvement. Hello! I would like to write documentation/tutorial to help new developers get from installation to use of koel on the following operating systems: Windows, and MacOS. I had reviewed the existing documentation (Official Documentation), but while I was going through it, I struggled to follow it on MacOS and had to look to outside resources to see how to install and use the product. This experience pushed me to want to write documentation/tutorial that could help create clarity and be able to ease people into use of the product. **Example** For example, clarifying how to build from source with MacOS because the commands will differ and being explicit on how to type the commands in. In comparison, the current instructions do not specify for MacOS.

kerem closed this issue

2026-02-26 02:34:48 +03:00

kerem commented

2026-02-26 02:34:48 +03:00

Author

Owner

@lexuanangel commented on GitHub (Jun 12, 2024):

Description:
This is my proposed addition to the installation documentaiton for Koel (MacOS):
Doc_MacOS.pdf

The structure of the document is number and goes from what needs to be done in order for someone who may not understand. There are still aspects to be improved on, but this can be seen as the start to breaking the wall of literacy to use Koel in conjunction with the other dependencies that need to be installed.

Example:
This can be used as an openable file or added to the Koel Documentation Guide and would help with reducing the amount of troubleshooting questions.

@lexuanangel commented on GitHub (Jun 12, 2024): Description: This is my proposed addition to the installation documentaiton for Koel (MacOS): [Doc_MacOS.pdf](https://github.com/user-attachments/files/15799144/Doc_MacOS.pdf) The structure of the document is number and goes from what needs to be done in order for someone who may not understand. There are still aspects to be improved on, but this can be seen as the start to breaking the wall of literacy to use Koel in conjunction with the other dependencies that need to be installed. Example: This can be used as an openable file or added to the Koel Documentation Guide and would help with reducing the amount of troubleshooting questions.

kerem commented

2026-02-26 02:34:48 +03:00

Author

Owner

@phanan commented on GitHub (Jul 6, 2024):

Thanks, but Koel isn't meant to provide (and with it, maintain) documentation for web development. I'd consider maybe adding a link to some good resource out there, but not more than that.

@phanan commented on GitHub (Jul 6, 2024): Thanks, but Koel isn't meant to provide (and with it, maintain) documentation for web development. I'd consider maybe adding a link to some good resource out there, but not more than that.

kerem referenced this issue

2026-02-26 03:31:12 +03:00

[PR #974] [CLOSED] Bump phpunit/phpunit from 7.5.9 to 8.1.5 #1485

No milestone

No project

No assignees

1 participant

Notifications

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference

starred/koel-koel#974

No description provided.

Rows
Columns