aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJay Berkenbilt <ejb@ql.org>2021-12-13 19:55:19 +0100
committerJay Berkenbilt <ejb@ql.org>2021-12-15 20:29:58 +0100
commitaddd6bef9598537eb8296a31d927e9a0c6c98d7f (patch)
tree3abc1acb5fcf8abb81efc8a8cfb846bc5e0bd25d
parent6187c8086ed41d55597a8796f68187b40c517a54 (diff)
downloadqpdf-addd6bef9598537eb8296a31d927e9a0c6c98d7f.tar.zst
TODO: documentation updates
-rw-r--r--TODO15
1 files changed, 12 insertions, 3 deletions
diff --git a/TODO b/TODO
index a4fa8704..1c847174 100644
--- a/TODO
+++ b/TODO
@@ -5,7 +5,7 @@ Next
* Refactor test_driver.cc so that runtest is not one huge function.
-* Consider creating a qpdf wiki.
+* Consider creating a qpdf wiki. See also Documentation below.
* For QPDFObjectHandle, provide a way on and after construction
to specify the error message that will be thrown if the
@@ -25,7 +25,7 @@ Before release:
* Figure out what to do about the fact that the release notes are now
at #release-notes instead of #ref.release-notes. This invalidates
the link in all previous release announcements, but there's not much
- I can do about, and it doesn't seem work fixing. Maybe mention it
+ I can do about, and it doesn't seem worth fixing. Maybe mention it
somewhere?
* README-maintainer: Fix installation of documentation to website
* Get navigation working properly
@@ -40,8 +40,17 @@ Soon:
Documentation
=============
+* Do a full pass through the documentation.
+
+ * Make sure `qpdf` is consistent. Use QPDF when just referring to
+ the package.
+ * Make sure markup is consistent
+ * Autogenerate where possible
+ * Consider which parts might be good candidates for moving to the
+ wiki.
+
* See #530 -- add an appendix explaining PDF encryption in general
- plus how it's handled by qpdf.
+ plus how it's handled by qpdf. Or maybe this should go on the wiki.
Document-level work