Refactor Docs for Devs and Users #1629
The documentation could be reorganized to better separate the info for users from the info for developers (themes and plugins). I'm thinking the Nav might look something like this (actual page titles and order subject to change):
Note that the
Much of the work consists simply of rearranging the existing documentation with minor edits to make the text fit in it's new context. However, the
Option two would certainly be more userful long term (and it provides a new feature for other users), but it would be more work as much of the source code has very limited documentation in the comments.
Whichever way we go, the rest of the work could be started now. The
The text was updated successfully, but these errors were encountered:
Quoting your comment in #1871 and moving the discussion over here:
The proposed changes may be a good start reducing any potential template-related issues that are opened here and related to non-default templates like for example
The reason why I did this is that quite recently there were a lot of one-line issues, some of them with questions that are either clearly answered in the docs or questions that are related to customizations for which I don't provide support for obvious reasons.
My biggest problem is that people think that
What happens? Most people just delete that stuff and go with LOL MY DOCS DON'T WORK HELP ME NOW KTHX. Neither a technical description of the bug, nor a reproducible case.
I agree that the template may be a little uncomfortable and box the reporter, but it's our spare time in which we answer those issues and help other people for no compensation whatsoever, so I really think it's absolutely fair to request a thoroughly researched issue which is easy to reproduce. I'm really sick of this.
During the file reorganization done in #2344, I noted that the theme documentation (now in
The document takes the approach that the theme dev would start out by using the