Skip to content

Docs: an "improve this page" feature#144939

Merged
nedbat merged 20 commits intopython:mainfrom
nedbat:nedbat/improve-docs-page
Feb 18, 2026
Merged

Docs: an "improve this page" feature#144939
nedbat merged 20 commits intopython:mainfrom
nedbat:nedbat/improve-docs-page

Conversation

@nedbat
Copy link
Member

@nedbat nedbat commented Feb 17, 2026

This PR picks up from #136246.

At the June 2025 Docs WG meeting, we talked about smoothing the path for people to suggest improvements to the docs. This is a start. It uses more JavaScript than we are used to.

I haven't done anything to trim down the "Report a bug" page. Ideas welcome.


📚 Documentation preview 📚: https://cpython-previews--144939.org.readthedocs.build/

Copy link
Member

@StanFromIreland StanFromIreland left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tested, everything works. I'm not a fan of the duplication, but as a start this is alright IMO.

@nedbat nedbat merged commit 7a7521b into python:main Feb 18, 2026
52 checks passed
@nedbat nedbat deleted the nedbat/improve-docs-page branch February 18, 2026 09:58
@nedbat nedbat added the needs backport to 3.14 bugs and security fixes label Feb 18, 2026
@miss-islington-app
Copy link

Thanks @nedbat for the PR 🌮🎉.. I'm working now to backport this PR to: 3.14.
🐍🍒⛏🤖

@miss-islington-app
Copy link

Sorry, @nedbat, I could not cleanly backport this to 3.14 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker 7a7521bcfad4a8346d460476de2e3fa11e412477 3.14

@bedevere-app
Copy link

bedevere-app bot commented Feb 18, 2026

GH-144943 is a backport of this pull request to the 3.14 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.14 bugs and security fixes label Feb 18, 2026
nedbat added a commit that referenced this pull request Feb 18, 2026
---------
(cherry picked from commit 7a7521b)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
bkap123 pushed a commit to bkap123/cpython that referenced this pull request Feb 28, 2026
* Docs: a start on an 'improve this page' feature

* pr feedback: simplify the link, and don't scare people with the cla

* pr feedback answered

- use the actual page URL
- tighten the wording

* fix the improve link on the improve page

* news item

* Update Doc/improve-page.rst

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>

* fix whitespace

* A nojs version of the page

* comments to help people keep the two pages in sync

* protect against XSS

* use template for issues from the nojs page

* use the template from the JS page as well

* give the docs issue template a fillable description field

* ugh, getting sloppy

* remove more sloppiness

---------

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants