cfdocs
cfdocs copied to clipboard
foundeo
Reports > To Do
Under functions the last dropdown list item in navigation is "Todo" which links to /reports/todo.cfm.
There "Todo" is written as one word; the "To Do" item in root level of the navigation is written as two. That's inconsistent.
Tags does not have an own "To Do" page.
/reports/todo.cfm seems to be the top level todo list because /reports/missing-descriptions.cfm, /reports/missing-examples.cfm and /reports/missing-related.cfm have their names included in url.
In https://github.com/foundeo/cfdocs/issues/516#issuecomment-325007705 you told me that you distinguish between between CFML as all and cfscript as a subset of it. All three todo lists ("Missing Descriptions", "Missing Examples" and "Missing Related Links") have a clear two column grid separation of tags and functions.
So you have two kinds of todos:
- "Missing x" in both tags and functions
- Missing tag or function itself
Should this be depicted in "To Do" dropdown navigation menu?
Should there perhaps be a "To Do" overview page which may include
- Boxes or cards linking to the todo subpages
- Statistics like "571 functions documented", "889 tags and functions in total", "87.29% descriptions complete"
- Specific examples how to solve the todos
Add specific todo lists like
- https://cfdocs.org/cf2016 for #305, #304, #301, #300, #295 and #289
Rather do
- create on parent issue for todos like "CF2016 Updated x"
- Insert a list via
- [ ]with the sub issues to parent issue description - List progress will be shown in Issue Overview
Yeah, this is a bit patchy because it has changed over time and things have gotten added in by various people. I think ultimately it would make more sense to remove the Todo Menu, and just have a Contribute menu item which has an overview of how to contribute, and then sub links to the areas that currently need work.
Should CONTRIBUTING.md be loaded as first item named "How to" in that menu?
@pfreitag @shaedrich I know this is an old issue, but I've been adding a bunch of missing functions. I've gone by the list of functions provided by Adobe or Lucee, but there are several others that are also missing. Would it be possible to add the page back that lists missing functions and tags, or to integrate that into the other pages?
Also, was the list of tags/functions automatically generated, or was it manually updated each time? I can't remember.
Love it when I dig a bit deeper into a question I have and find that I not only asked pretty much the same question 5 years ago, but got an answer and submitted a PR for it. #421
I can do this again for 2021, if needed/wanted, but it also goes to my other question of should the To Do page that lists missing functions be added back in some way?