Pest: Documentation / UX: Improvements ideas

Created on 13 Jun 2020  路  6Comments  路  Source: pestphp/pest

Let's list here the changes we would like to make to the docs in a futur overhaul.

documentation

Most helpful comment

Idea 2:

Provide a Copy to Clipboard button next to relevant command lines.

Example:

Capture d鈥檈虂cran 2020-06-13 a虁 17 26 07

All 6 comments

Idea 1:

Provide a Table of Contents and Anchors links on Headers on documentation pages.

Example:

The Laravel documentation nails that and is easy to link to:

Capture d鈥檈虂cran 2020-06-13 a虁 12 03 54

Idea 2:

Provide a Copy to Clipboard button next to relevant command lines.

Example:

Capture d鈥檈虂cran 2020-06-13 a虁 17 26 07

@octoper Can you work on this one? I would love, but I am afraid on don't have the skills.

I'm on it @nunomaduro

Posting @octoper 's idea before it gets buried since he's busy for now:

Idea 3:

Provide a version selector for the documentation, if/when we'll have breaking changes in the API.

_I think for the moment it's not urgent, as Pest development is still moving fast and we are expecting people to update to latest version. This can wait until everything settle down a bit perhaps?_

Closing as this has mostly all been implemented on the new site, and the version is planned in future. :+1:

Was this page helpful?
0 / 5 - 0 ratings