Update the README and documentation#42
Conversation
Squash-merge of FriendsOfBehat#42. Squashed commit of the following: commit 3232451 Author: Matthias Pigulla <mp@webfactory.de> Date: Wed Dec 17 13:42:33 2025 +0100 Update the README and documentation
aik099
left a comment
There was a problem hiding this comment.
I see that you've changed documentation and changed a documentation file format in the same PR. This makes it hard to review.
Could you instead:
- change documentation format in this PR
- create another PR with documentation changes (you can only create it after the documentation format change PR is merged)
|
@stof , could you please grant me more access to this repo. Right now I'm unable to:
The access level that I have on minkphp organization should be sufficient 😄 . |
README.md
Outdated
| @@ -1,5 +1,18 @@ | |||
| This is the fork of MinkExtension library that supports PHP `>=7.4` and supports Symfony `>=4.4`. | |||
| # Mink Extension for Behat | |||
There was a problem hiding this comment.
We could start with a copy/paste of README of the original repository (see https://github.com/Behat/MinkExtension) with some parts (about abandoned repo) omitted.
That would ease the review. As another PR we improve README contents. This way it's easier to understand what was changed into what.
There was a problem hiding this comment.
As requested, I have changed the README to be what the original repository had, only with the part about the fork being removed.
Will open a separate PR for my README suggestions after we get this one here merged.
|
If you guys agree I'll migrate to markdown first in a new PR, then later rebase this one and other ones affecting documentation. |
|
Let's first get #45 merged, then I'll rebase this one here. |
3232451 to
1a5a48a
Compare
|
Rebased. Now it's much clearer to see what I intended. |
1a5a48a to
f1ddee0
Compare
| * `mink_loader` - path to a file loaded to make Mink available (useful when | ||
| using the PHAR archive for Mink, useless when using Composer) | ||
|
|
||
| ## Adding your own or other drivers |
There was a problem hiding this comment.
Maybe we should mention somewhere than friends-of-behat/symfony-extension registers a browserkit_symfony driver factory (or maybe just symfony, I don't remember the exact name) ?
There was a problem hiding this comment.
You mean as an example?
We cannot have a complete list here of every other extension that adds drivers.
There was a problem hiding this comment.
both as an example, and as a reference because it is an extension of the same organization.
Co-authored-by: Christophe Coevoet <stof@notk.org>
Co-authored-by: Christophe Coevoet <stof@notk.org>
This updates the README and improves documentation a bit.
As requested in #42 (review), the README is a copy from the original upstream repo with only slight changes.
Closes #27.