Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

documentation versioning #275

Open
ypylypenko opened this issue Sep 9, 2024 · 5 comments
Open

documentation versioning #275

ypylypenko opened this issue Sep 9, 2024 · 5 comments

Comments

@ypylypenko
Copy link

ypylypenko commented Sep 9, 2024

Hi. Thank you for PEST, really enjoy working with it.
Since version 3 of PEST has already been released, I would like to ask if you are planning to introduce versioning for the documentation on the website, and if any help is needed with this? Currently, it's unfortunately difficult to understand which feature is available in which version in the documentation..

thank you

@owenvoke
Copy link
Member

The documentation always shows the latest versions functionality, so it will show features from 3.x onwards.

I think it would be nice to have versioning, but not sure if the team want the maintenance overhead of 2 documentations. 🤔 A possible feature we could have is to have badges with v3.0+ (or similar) that is shown next to features. That way we can see when a specific feature was added. 🤷🏻

@ypylypenko
Copy link
Author

Thank you for your response! I think adding version badges (e.g., v3.0+) is a great idea and would be very helpful for those who haven’t yet transitioned to version 3 (me 🫣) of the framework. It will definitely make it easier to understand which features are available in which version.

If any assistance is needed with implementing, I’d be happy to help.

@andho
Copy link

andho commented Oct 1, 2024

Can you have the v2 docs hosted somewhere at least? After all, version 3 just came out, and the library seems to be very strongly tied to laravel because of nunomaduro/termwind so it's not possible to update without updating the framework.

@dmachiavello
Copy link

Yes, another vote for documentation versioning, like the official Laravel Docs. Some of us don't have control of our environments and cannot upgrade to Pest 3 because of requirements, so seeing a v2 would be great!

@carlcasbolt
Copy link
Contributor

Would it be viable to tag this documentation prior to the v3 merge here - 41a78ca and then there is a last state of master pre-v3 changes

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

5 participants