request for documentation page and location to put it
lion at netngine.hu
Wed Aug 6 21:32:55 CEST 2008
Errata pages are common, as roh mentioned. Note, that those are linked
to specific product versions usually. E.g. you can have an error list of
2008.8, but you cannot have an error list of SVN r3434.
So if you want to document errors linked to a specific official release,
it's good to make an Errata and of course a Release Notes. Make sure to
include "Openmoko 2008.8" in the name. (Openmoko 2008.8 Release notes
and Openmoko 2008.8 Errata) (Then you could still add "known issues"
words to that page in the intro to let it find well.)
Michael Shiloh írta, 2008-08-02 08:38 keltezéssel:
> Look at it from the point of view of a new user (still developer, like
> us, but new to the community). You get the device and charge it up and
> find that your SIM card doesn't work and/or GPS doesn't work or whatever.
Getting started FAQ is cool for this I think. Also the big FAQ should be
cleaned a bit to reflect frequently asked questions.
(Note: "What is Openmoko" is definately a FAQ. Also many more of the
general questions, please do not remove them. Very often on a completely
unkown page I go to FAQ to find out what the linked product/software is
in general and decide whether that's what I need.)
> Had you been on the mailing list for the past couple of weeks you would
> know exactly what is going on. But you just joined. So you visit the wiki.
> Would you expect to find this on the wiki, and, if so, what keywords
> would you expect?
> To me, "Known Issues" are the keywords I would look for.
No. If you cannot find Terminal in ASU you will type "ASU Terminal" in
If there is a FAQ question in Getting Started FAQ saying "Where is the
Terminal in ASU", you have a good chance to find it.
Hehe, sorry, actually I think I would never write "known issues". Two
1. Known issues of what? Neo 1973 in 2007? Keyboard in ASU? How will you
maintain that page? Will you remove 2007.2 issues when ASU is released?
2. I know that there are zillions of known issues in all software. But I
want a solution for a specific one. :-p
More information about the documentation