mirror of
https://github.com/python/cpython.git
synced 2026-04-15 00:00:57 +00:00
7a7521bcfa
* 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>
29 lines
1.1 KiB
ReStructuredText
29 lines
1.1 KiB
ReStructuredText
:orphan:
|
|
|
|
****************************
|
|
Improve a documentation page
|
|
****************************
|
|
|
|
.. This is the no-javascript version of this page. The one most people
|
|
will see (with JavaScript enabled) is improve-page.rst. If you edit
|
|
this page, please also edit that one, and vice versa.
|
|
|
|
.. only:: html and not epub
|
|
|
|
We are always interested to hear ideas about improvements to the documentation.
|
|
|
|
.. only:: translation
|
|
|
|
If the bug or suggested improvement concerns the translation of this
|
|
documentation, open an issue or edit the page in
|
|
`translation's repository <TRANSLATION_REPO_>`_ instead.
|
|
|
|
You have a few ways to ask questions or suggest changes:
|
|
|
|
- You can start a discussion about the page on the Python discussion forum.
|
|
This link will start a topic in the Documentation category:
|
|
`New Documentation topic <https://discuss.python.org/new-topic?category=documentation>`_.
|
|
|
|
- You can open an issue on the Python GitHub issue tracker. This link will
|
|
create a new issue with the "docs" label:
|
|
`New docs issue <https://github.com/python/cpython/issues/new?template=documentation.yml>`_.
|