Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Add TODO file
  • Loading branch information
Mouq committed Jun 16, 2014
1 parent 48f8964 commit 123caf2
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions TODO
@@ -0,0 +1,29 @@
Definites:
htmlify.p6:
* Create and gather meta-data for subtypes for Type docs
* Generate sub-indices for subtypes, like exceptions,
subroutines, etc.
* Allow to define a routine, type, or module in any documentation, which
will allow for disambiguation pages to point to better, more
contextful docs, and for less redundancy in the docs
overall.
* Update gathering of info on routines so that things defined as
both subs and methods will be displayed as such.
* Emit a warning when formatting is bad. E.g., a routine that
doesn't have a defining code block, or a page that lacks a
proper title.
* Figure out a way to cache and update the documentation
registry, and when to or not to regenerate individual pages.
* Write/generate a short description for the items of the indices
* Create a .tar.gz to satisfy the index page's claim that
"you can also download an offline HTML ... copy"
Interface:
* Add non-faded Camelia image for the index page
* Rewrite index page as index.pod so it can be automatically generated
* Fix redirection in app.pl to redirect to a 404 page
* Make "Search" disappear when the search bar is selected
* Normalize the titles of the Language docs a bit
Maybes:
* Add "Formalities" page
* Make links automatically be formatted super pretty, as with "language>intro"
* A PDF version of the documentation

0 comments on commit 123caf2

Please sign in to comment.