Commit addd6bef9598537eb8296a31d927e9a0c6c98d7f
1 parent
6187c808
TODO: documentation updates
Showing
1 changed file
with
12 additions
and
3 deletions
TODO
| @@ -5,7 +5,7 @@ Next | @@ -5,7 +5,7 @@ Next | ||
| 5 | 5 | ||
| 6 | * Refactor test_driver.cc so that runtest is not one huge function. | 6 | * Refactor test_driver.cc so that runtest is not one huge function. |
| 7 | 7 | ||
| 8 | -* Consider creating a qpdf wiki. | 8 | +* Consider creating a qpdf wiki. See also Documentation below. |
| 9 | 9 | ||
| 10 | * For QPDFObjectHandle, provide a way on and after construction | 10 | * For QPDFObjectHandle, provide a way on and after construction |
| 11 | to specify the error message that will be thrown if the | 11 | to specify the error message that will be thrown if the |
| @@ -25,7 +25,7 @@ Before release: | @@ -25,7 +25,7 @@ Before release: | ||
| 25 | * Figure out what to do about the fact that the release notes are now | 25 | * Figure out what to do about the fact that the release notes are now |
| 26 | at #release-notes instead of #ref.release-notes. This invalidates | 26 | at #release-notes instead of #ref.release-notes. This invalidates |
| 27 | the link in all previous release announcements, but there's not much | 27 | the link in all previous release announcements, but there's not much |
| 28 | - I can do about, and it doesn't seem work fixing. Maybe mention it | 28 | + I can do about, and it doesn't seem worth fixing. Maybe mention it |
| 29 | somewhere? | 29 | somewhere? |
| 30 | * README-maintainer: Fix installation of documentation to website | 30 | * README-maintainer: Fix installation of documentation to website |
| 31 | * Get navigation working properly | 31 | * Get navigation working properly |
| @@ -40,8 +40,17 @@ Soon: | @@ -40,8 +40,17 @@ Soon: | ||
| 40 | Documentation | 40 | Documentation |
| 41 | ============= | 41 | ============= |
| 42 | 42 | ||
| 43 | +* Do a full pass through the documentation. | ||
| 44 | + | ||
| 45 | + * Make sure `qpdf` is consistent. Use QPDF when just referring to | ||
| 46 | + the package. | ||
| 47 | + * Make sure markup is consistent | ||
| 48 | + * Autogenerate where possible | ||
| 49 | + * Consider which parts might be good candidates for moving to the | ||
| 50 | + wiki. | ||
| 51 | + | ||
| 43 | * See #530 -- add an appendix explaining PDF encryption in general | 52 | * See #530 -- add an appendix explaining PDF encryption in general |
| 44 | - plus how it's handled by qpdf. | 53 | + plus how it's handled by qpdf. Or maybe this should go on the wiki. |
| 45 | 54 | ||
| 46 | 55 | ||
| 47 | Document-level work | 56 | Document-level work |