Changes between Version 1 and Version 2 of DocsTasklist

Timestamp:

11/21/09 11:52:46 (12 years ago)

Author:

allison

Comment:

--

DocsTasklist

@@ -1 @@
-Find all examples of PIR embedded in POD documentation anywhere in the repository, and wrap them in PIR target blocks like this:
+ * All top-level docs/* files should be user-focused. Put internals and developer documentation in docs/internals/... (users shouldn't have to dig to find help getting started, experienced developers can easily handle an extra directory level).
+ * Adjust the 'make html' generators Parrot::Docs::* to match the new paths.
+
+ * Find all examples of PIR embedded in Pod documentation anywhere in the repository, and wrap them in PIR target blocks like this:
 
 
@@ -13 +16 @@
 }}}
 
-For bonus points, run {{{t/examples/pod.t}}} after you do this and fix any errors this finds in the sample PIR.
+For now, only do this with PIR examples that contain complete subs and are expected to work. Partial examples can be wrapped with PIR_FRAGMENT instead. Examples that aren't expected to work can be wrapped in PIR_INVALID or PIR_FRAGMENT_INVALID, and examples that should work but currently don't can be wrapped in PIR_TODO or PIR_FRAGMENT_TODO.
 
-For now, only do this with PIR examples that contain complete subs and are expected to work.
+* For bonus points, run {{{t/examples/pod.t}}} after you do this and fix any errors this finds in the sample PIR.
+
+