Skip to content

Conversation

@davidhewitt
Copy link
Member

Our migration guide is getting extremely long. I'd like to make it easier for users reading performing just the latest upgrade to easily scan for the content relevant for them.

One option would be to split the migration guide over several pages, but I think any such splitting (other than recent version split from the rest) would be quite arbitrary and also be harder to track.

I propose here to add <details> tags to every section older than the current upgrade, to collapse the content. I also added some styling for these tags so that the list renders in a readable way.

Here's what this looks like on my machine:

image

@Icxolu
Copy link
Contributor

Icxolu commented Mar 15, 2024

I like the idea! I'd definitely prefer this over splitting. We could also add those for the current release, but have them expanded by default. That way you could close the ones that you already dealt with or won't affect you. Just something that came to mind, not sure if necessary.

@davidhewitt
Copy link
Member Author

We could also add those for the current release, but have them expanded by default. That way you could close the ones that you already dealt with or won't affect you. Just something that came to mind, not sure if necessary.

I like this! To avoid conflicts with a PR I'm currently writing for #3958, would it be ok to push those tags as part of that PR?

@Icxolu
Copy link
Contributor

Icxolu commented Mar 15, 2024

would it be ok to push those tags as part of that PR?

I'm fine with that 👍

@davidhewitt
Copy link
Member Author

I think we're happy with this, so I'll proceed to merge.

@davidhewitt davidhewitt added this pull request to the merge queue Mar 19, 2024
Merged via the queue into PyO3:main with commit e29fac9 Mar 19, 2024
@davidhewitt davidhewitt deleted the migration-details branch March 19, 2024 10:30
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

Successfully merging this pull request may close these issues.

2 participants