php / php/frankenphp

Docs improvements?

Open
#691 1 comment 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Go
Stars
11.3k
Forks
488
Avg merge
4d 10h
Merged PRs (30d)
11

Description

Describe you feature request

Is your feature request related to a problem? Please describe.

I was shoulder-surfing a colleague today while I had them install frankenphp for a quick PHP server. There wasn't a clear way to download FrankenPHP, and they got a bit lost on frankenphp.dev.

Describe the solution you'd like

  • Perhaps add a top-nav called "Download" that simply navigates to the latest release or getting-started page.
  • On the getting started page, most of the above-the-fold is taken up by a logo, forcing the person to scroll quite a ways down the page to actually get started. The logo is nice, but huge.

Describe alternatives you've considered

This was just from shoulder-surfing a dev, it might be worth shoulder-surfing more devs.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the frankenphp.dev navigation and getting-started page described in the issue. Check how users currently find downloads and how much of the page is occupied by the logo; done means a clear download path and a more accessible getting-started view.

Written by the indexing model from the issue text.

Assessment

Tech stack
php
Domain
design, documentation, web-dev
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.