Tirsvad-Udemy-100-days-of-code/026-nato-alphabet
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

MIL-003 Documentation and publication #23

Merged
Tirsvad merged 3 commits from mil-003-documentation-and-publication into main 2026-10-13 10:49:04 +02:00
Conversation 0 Commits 3 Files Changed 21
+772 -10
Tirsvad commented 2026-10-13 10:47:50 +02:00
Owner
Copy Link
Copy Source

MIL-003 Documentation and publication (autonomous mode).

Go / No-Go criteria of MIL-003:

  1. check-readme.sh: exit 0, no finding.
  2. README steps on Windows PowerShell from a fresh clone of this branch: venv, pip upgrade, install, run (Hello spelled), pytest (50 passed), ruff, lint-imports and doxygen all succeed.
  3. Wiki pages Home, Install, Usage and Development exist in en, da (-da) and ms (-ms) plus _Sidebar; published on the host, all return HTTP 200.
  4. Screenshots (docs/images/spell-word.png, retry-invalid.png) are in the README and in every wiki language. They are rendered from the program's real output, not native window captures.
  5. Wiki published at https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/026-nato-alphabet/wiki.
  6. doxygen Doxyfile: exit 0, no warnings; README section "Build the source documentation".

Notes: the README keeps the framework template's headings (checked by check-readme.sh) and adds the sections of the Product Owner's skeleton (Continuous integration, Build the source documentation, Project layout, per-OS Setup). Doxygen now reads src/ only (README links to non-source files made it fail) and uses short file names so that deep Windows paths work. Review RC-015.

Closes #14
Closes #15
Closes #16
Closes #17
Closes #18
Closes #19
Closes #20

MIL-003 Documentation and publication (autonomous mode). Go / No-Go criteria of MIL-003: 1. `check-readme.sh`: exit 0, no finding. 2. README steps on Windows PowerShell from a fresh clone of this branch: venv, pip upgrade, install, run (Hello spelled), pytest (50 passed), ruff, lint-imports and doxygen all succeed. 3. Wiki pages Home, Install, Usage and Development exist in en, da (`-da`) and ms (`-ms`) plus `_Sidebar`; published on the host, all return HTTP 200. 4. Screenshots (`docs/images/spell-word.png`, `retry-invalid.png`) are in the README and in every wiki language. They are rendered from the program's real output, not native window captures. 5. Wiki published at https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/026-nato-alphabet/wiki. 6. `doxygen Doxyfile`: exit 0, no warnings; README section "Build the source documentation". Notes: the README keeps the framework template's headings (checked by `check-readme.sh`) and adds the sections of the Product Owner's skeleton (Continuous integration, Build the source documentation, Project layout, per-OS Setup). Doxygen now reads `src/` only (README links to non-source files made it fail) and uses short file names so that deep Windows paths work. Review RC-015. Closes #14 Closes #15 Closes #16 Closes #17 Closes #18 Closes #19 Closes #20
Tirsvad added 3 commits 2026-10-13 10:47:51 +02:00
Add README, screenshots and wiki in English, Danish and Bahasa Malaysia
CI / Test on Python 3.13 (push) Successful in 55s
Details
d932c7fa4f 
Task: MIL-003#1
Task: MIL-003#2
Refs #14
Refs #15
Refs #16
Refs #17
Refs #18
Review MIL-003 changes; shorten Doxygen file names for deep Windows paths 92b954331c 
Task: MIL-003#7
Refs #19
Refs #20
Resolve pending commit links for MIL-003
CI / Test on Python 3.13 (pull_request) Successful in 53s
Details
402f0c9e1a
Tirsvad merged commit 404795184a into main 2026-10-13 10:49:04 +02:00
Sign in to join this conversation.
Reviewers
No Reviewers
Labels
No items
No labels
Milestone
No items
No Milestone
Projects
Clear projects
No projects
Assignees
Clear assignees
Tirsvad
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: Tirsvad-Udemy-100-days-of-code/026-nato-alphabet#23