Skip to content

Commit a7ab5d6

Browse files
committed
Update README for current project structure and progress
1 parent 2da7fe8 commit a7ab5d6

1 file changed

Lines changed: 59 additions & 43 deletions

File tree

‎README.md‎

Lines changed: 59 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -2,37 +2,44 @@
22

33
Punjabi (India) translation of the Python documentation.
44

5-
This project aims to translate Python's official documentation into
6-
Punjabi (Gurmukhi) and make Python learning resources more accessible
7-
to Punjabi-speaking developers, students, and educators.
5+
This project aims to translate Python's official documentation into Punjabi (Gurmukhi) and make Python learning resources more accessible to Punjabi-speaking developers, students, and educators.
86

97
## Status
108

119
🚧 Work in Progress
1210

11+
Current focus: completing `tutorial/classes.po` and preparing completed translations for Transifex upload.
12+
1313
## Current Progress
1414

15-
Tutorial Section
15+
### Completed Tutorial Files
16+
17+
| File | Status | Messages |
18+
| ----------------- | ---------- | -------- |
19+
| introduction.po | ✅ Complete | 120 |
20+
| interpreter.po | ✅ Complete | 33 |
21+
| appetite.po | ✅ Complete | 17 |
22+
| controlflow.po | ✅ Complete | 226 |
23+
| datastructures.po | ✅ Complete | 139 |
24+
| inputoutput.po | ✅ Complete | 112 |
25+
| modules.po | ✅ Complete | 116 |
26+
| errors.po | ✅ Complete | 96 |
1627

17-
| File | Status | Messages |
18-
|------|--------|----------|
19-
| introduction.po | Complete | 120 |
20-
| interpreter.po | Complete | 33 |
21-
| appetite.po | Complete | 17 |
22-
| controlflow.po | Complete | 226 |
23-
| datastructures.po | Complete | 139 |
24-
| inputoutput.po | Complete | 112 |
25-
| modules.po | Complete | 116 |
26-
| errors.po | Complete | 96 |
28+
**Completed tutorial strings:** 859
2729

28-
Total translated tutorial messages: 859
30+
### In Progress
2931

30-
Infrastructure
32+
| File | Progress |
33+
| ---------- | ---------------- |
34+
| classes.po | 49 / 154 (31.8%) |
3135

32-
* STYLE_GUIDE.md — Complete
33-
* GLOSSARY.md — Complete
34-
* CONTRIBUTING.md — Complete
35-
* GitHub Actions validation workflow — Complete
36+
### Infrastructure
37+
38+
* ✅ STYLE_GUIDE.md
39+
* ✅ GLOSSARY.md
40+
* ✅ CONTRIBUTING.md
41+
* ✅ GitHub Actions validation workflow
42+
* ✅ Repository structure aligned with Python documentation translation recommendations
3643

3744
## Goals
3845

@@ -45,46 +52,55 @@ Infrastructure
4552

4653
## Repository Structure
4754

48-
::
49-
50-
```
55+
```text
5156
python-docs-pa-in/
52-
├── README.rst
53-
├── STYLE_GUIDE.md
54-
├── GLOSSARY.md
57+
├── README.md
5558
├── CONTRIBUTING.md
56-
├── .github/workflows/
59+
├── GLOSSARY.md
60+
├── STYLE_GUIDE.md
61+
├── .github/
62+
│ └── workflows/
63+
│ └── validate.yml
64+
├── tutorial/
65+
│ ├── appetite.po
66+
│ ├── classes.po
67+
│ ├── controlflow.po
68+
│ ├── datastructures.po
69+
│ ├── errors.po
70+
│ ├── inputoutput.po
71+
│ ├── interpreter.po
72+
│ ├── introduction.po
73+
│ └── modules.po
5774
├── library/
5875
├── reference/
59-
├── tutorial/
6076
├── using/
61-
├── whatsnew/
62-
└── locales/pa-IN/LC_MESSAGES/
77+
└── whatsnew/
6378
```
6479

6580
## Translation Workflow
6681

67-
1. Translate .po files.
68-
69-
2. Validate using::
82+
1. Translate `.po` files.
83+
2. Validate translations:
7084

71-
```
72-
msgfmt --check file.po
73-
```
85+
```bash
86+
msgfmt --check tutorial/FILENAME.po
87+
```
7488

7589
3. Review terminology against `GLOSSARY.md`.
90+
4. Follow rules in `STYLE_GUIDE.md`.
91+
5. Ensure RST roles, directives, and code blocks remain unchanged.
92+
6. Commit and push changes.
93+
7. Verify GitHub Actions passes successfully.
7694

77-
4. Ensure markup and code blocks remain intact.
95+
## References
7896

79-
5. Commit and submit changes.
97+
Python Documentation Translation Guide:
8098

81-
## References
99+
https://devguide.python.org/documentation/translations/
82100

83-
* Python Documentation Translation Guide:
84-
https://devguide.python.org/documentation/translations/
101+
Python Documentation Project:
85102

86-
* Python Documentation Project:
87-
https://docs.python.org/
103+
https://docs.python.org/
88104

89105
## License
90106

0 commit comments

Comments
 (0)