Skip to content

Simplify and update the project documentation - #2

Draft
BHUVANSH855 wants to merge 12 commits into
python:3.15from
BHUVANSH855:docs/simplify-markdown
Draft

BHUVANSH855 wants to merge 12 commits into
python:3.15from
BHUVANSH855:docs/simplify-markdown

Conversation

@BHUVANSH855

Copy link
Copy Markdown
Collaborator

Fixes #1

This pull request simplifies the project documentation and updates it for the move to the python organization.

Changes

  • Add README.md (Punjabi) and README.en.md (English), linked to each other, as the Polish translation does.
  • Shorten CONTRIBUTING.md, STYLE_GUIDE.md, RULES.md, GLOSSARY.md and Transifex_Setup.md, so that each can be read in one sitting and has one clear job. The outdated project status, statistics and per-file lists are removed.
  • Fix the description of publishing: the documentation is built from this repository and published at https://docs.python.org/pa/, not "submitted upstream to CPython".
  • Remove PROJECT_REPORT.md.
  • Update the issue templates, the pull request template and config.yml. The links now point to python/python-docs-pa.
  • Replace the custom Code of Conduct with a pointer to the PSF Code of Conduct.

No .po files and no workflows are changed.

Notes

  • The READMEs link to https://docs.python.org/pa/. We would like to merge this after the first documentation build that includes pa, so that the link works.
  • The CC0 license sentence is kept as it was.

@BHUVANSH855 BHUVANSH855 added action: review Needs review form team. refactor labels Oct 22, 2026
@BHUVANSH855
BHUVANSH855 marked this pull request as draft October 22, 2026 17:59
@BHUVANSH855 BHUVANSH855 self-assigned this Oct 22, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

action: review Needs review form team. refactor

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Simplify and update the project’s documentation

1 participant