LaTeX is great, but I also think basic man pages are pretty handy too. For the developer, firmware maintainer, or system hacker; the OpenWRT "SDK" man pages can simply be added to the package man pages to provide build/target system documentation.
Highlights: - Easy to code, search, and use (with 'less' or 'man') - Building on the documentation of the system/packages themselves - Packages themselves could provide build/developer man pages - Separation of audiences (with the man classes for system, user, etc) - Probably numerous man2xxx programs for format conversions - I hacked up one for man2wiki in about an hour - A simple man wrapper in OpenWRT buildroot could provide easy access to all this version specific documentation from the command prompt - It is more "standard" in terms of system and SDK documentation For the basic end-users, that has to be documentation of the GUI - another matter. cheers, David On Sep 8, 2007, at 10:38 PM, David Farning wrote: > I have spent the last couple of days thinking about how to define > OpenWrt. One thing is for sure. It is no longer a modified firmware > of Linksys! > > OpenWrt has become a full fledged Linux distribution for Network > Appliances. The closest thing out there to OpenWrt is OpenMoko, the > the self titled 'mobile device os.' > > One of the reasons the current documentation is confusing and > disorganized is that specific users of the information have not been > identified. For example: > -Basic End-users just want to install a new firmware with few > surprises. > -Advanced End-users are willing to work for advanced functionality but > don't to write code. > -Application developers want to know how to write applications and > package them for OpenWrt. > -Kernel hackers want to be able to efficiently port OpenWrt to > additional platforms. > -Tool chain developers who assemble the tools necessary to make the > various parts fit together. > > It looks like a lot of the frustration over the past couple of months > has been caused by these users rubbing each other the wrong way. In > the immortal words of kernel hackers everywhere, “I don't do user > space.” How may users care how a the memory manager works? > > I would like to propose that we start to refactor the existing > documentation according to the needs of the above groups. (Yes, I am > volunteering to do the work.) > > Thanks, > David Farning > > _______________________________________________ > openwrt-devel mailing list > openwrt-devel@lists.openwrt.org > http://lists.openwrt.org/cgi-bin/mailman/listinfo/openwrt-devel _______________________________________________ openwrt-devel mailing list openwrt-devel@lists.openwrt.org http://lists.openwrt.org/cgi-bin/mailman/listinfo/openwrt-devel
