Slim the README to a landing page (#30)#61
Open
jensens wants to merge 1 commit into
Open
Conversation
The README carried the full fixture catalog by hand, duplicating every docstring. That is the double maintenance the documentation effort set out to remove: now that the reference is published at plone.github.io/pytest-plone, the README only needs to point at it. Keep the badges, a one-paragraph intro, install, a short quickstart, and a set of links into the documentation. Drop the fixture catalog, the marker reference, and the session-wide-layers explanation -- all now covered in the docs. Also correct the contributor Python requirement from 3.8 to 3.10, which is the actual requires-python, and note make docs.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Follow-up to #56, and the last piece of #30.
Why
The README carried the full fixture catalog by hand — 755 lines, one section per fixture — duplicating every docstring. That is exactly the double maintenance the documentation effort set out to remove. Now that the reference is published at plone.github.io/pytest-plone, the README only needs to point at it.
What
755 → 93 lines. Kept: badges, a one-paragraph intro, install, a short quickstart, and a set of links into the documentation. Dropped: the fixture catalog, the marker reference, and the session-wide-layers explanation — all now covered in the docs.
Every topic removed from the README was verified to exist in the published docs, so nothing is lost:
@pytest.mark.portalkeep_sessionReasoningAll five documentation links in the new README were checked to resolve (HTTP 200).
Also
Corrected the contributor Python requirement from 3.8 to 3.10, which is the actual
requires-python, and mentionedmake docs.🤖 Generated with Claude Code