[wp-docs] Static Pages

Owen Winkler ringmaster at midnightcircus.com
Tue Dec 14 00:53:30 UTC 2004


Podz wrote:

> Owen Winkler wrote:
>
>>> I would very much like to have some work done on 1.3's file 
>>> structure before it goes live. While existing 1.2 users have 
>>> something to draw on - and a tutorial page could point to 1.2 
>>> experience, new 1.3 users will not, and no doubt the usual "We had 
>>> this in xxx" will surface, so some prior work would / will / shall 
>>> (note the optimism :) ) be useful.
>>
>>
>> Do you want like a directory map, then?  What each directory/file is 
>> for?  I will do that if you like.
>
>
> Thanks.. and I don't know :)
> I don't know where to start with 1.3 to be honest ... at what level to 
> pitch it.

Oh, I've got a prety good handle on what they're about.  :)
I'll start work and you can suggest format changes later.  Gimme a day 
to assemble it.

Something I had been planning on for RedAlt was a WP developer function 
reference, so this fits in pretty well with that parallel goal.  ("I 
want to write a plugin, and I know there's a function in WP that does 
this already, but I don't know where or what it's called, so I'll just 
rewrite the whole darned thing."  Eep.)

> Okay ... question for lurkers too :)
> (This has been asked before I know, but I've not looked for the result)
> - Should the docs for 1.3 follow the format of the admin menu ?
> * Ignore the fact that the admin menu can be altered
> * Ignore the fact that each menu element is not equal in doc terms
> * Ignore the fact that we discussed this before.

I agree with Matt on the task-oriented approach, although I haven't seen 
a lot of screen time on what that consists of exactly. 

I had started an index (for my own satisfaction in having done it, not 
necessarily for any common good) that was oriented this way here:
http://codex.wordpress.org/User:ringmaster

Don't make much of the content, but do observe the crazy-seeming 
"Features by..." sections.  My thought was to approach it in a use-case 
mindset.  Who will be using the software, what for, and in what order.

There is also no great reason I can think of to omit a reference to 
existing capabilities in order of admin menu, if only so that editors 
can more easily find those sections without sifting through a bunch of 
how-to questions.  I mean, it's not a space constraint issue, is it?

> I've announced the static page on the forum, but I will move it to 
> Codex and as I understand little about this, one of you guys can make 
> any changes to that page then ?

Cool.  What's the easiest way to know when it goes online?  And am I 
going to regret asking that question?

Owen







More information about the docs mailing list