Note This refers to the online version of the help pages only. We compare with the current Programming Reference Guide. Checking the PDF and CHM are separate issues. Also, hidden disambiguation pages and other files not directly visible in a browser are not in scope.
Tick each box you have proof read old-vs-new side by side. A tick means that the content has been verified to be the same. That means that if there is a spelling mistake in the old version, it should also be present in the new version.
Fixes should be made in a single, new branch named 1-check-programmers-reference-guide. The 1 here is the issue ID.
Work on this issue if it is assigned to you only. If it is unassigned, assign it to yourself first. Fixes are preferred in Markdown; where possible, avoid HTML and CSS.
If you find structural deficiencies that requires the moving of files, or the changing of the mkdocs.yml file, please notify Stefan directly.
Note Fixes should address content only: omissions, additions, missing/malformed tables, missing images, or dangling links. Formatting and style differences should be ignored for now.
Here are the sections of the Programmer's Reference Guide.
Tick each box you have proof read old-vs-new side by side. A tick means that the content has been verified to be the same. That means that if there is a spelling mistake in the old version, it should also be present in the new version.
Fixes should be made in a single, new branch named
1-check-programmers-reference-guide
. The1
here is the issue ID.Work on this issue if it is assigned to you only. If it is unassigned, assign it to yourself first. Fixes are preferred in Markdown; where possible, avoid HTML and CSS.
If you find structural deficiencies that requires the moving of files, or the changing of the
mkdocs.yml
file, please notify Stefan directly.