OpenWrt Forum Archive

Topic: Automating documentation for OpenWrt

The content of this topic has been archived on 3 Apr 2018. There are no obvious gaps in this topic, but there may still be some posts missing at the end.

jessemonroy650 wrote:

Hi all,
you may have seen a handful of changes by me - nothing more than syntax corrections. I'm currently documenting the Arduino Yun, however I was waiting until someone to the reigns of this documentation effort before jumping in with both feet. wink

A little background, I working on starting my own company that does robotic platforms (sort of chassis for robot builders). In the meantime, I must work on making money - so I do full stack mobile development. Right now I spend most of my time on the Arduino Yun forum, the phonegap, then bluetooth, then this forum. It's about to change. So here we go.....

Since I do automated documentatio (based on source code). I will ask which language are people most comfortable with. I can do PERL, Python, Bash, TCL/TK, Javascript or Lua (if I learn it). My favorite is TCL/TK, but I'm thinking Python, since it's widely preferred, but I'd like some opinions.

After that I'm going to ask where are all the source repositories. I'll start with the forest, then work the trees. (pun intended). big_smile

Jesse

This was moved over from the "Initiative to improve OpenWrt documentation" thread.

(Last edited by richbhanover on 9 May 2015, 11:09)

richbhanover wrote:

Hi Jesse,

Thanks for the changes you're making to the wiki. Creating documentation from source code sounds quite interesting, but it's a bit off-topic for this thread. (We're focused on fixing the pages we already have that are outdated, misleading, and not targeted toward getting new people started on OpenWrt.)

I have taken the liberty of starting a new topic on the Community Documentation forum at:https://forum.openwrt.org/viewtopic.php … 57#p275757

Best regards,

Rich Brown

Hi Rich,
first thanks for making a copy of my message, I don't think it was needed, but thanks. The, with all due respect perhaps you can clarity me your thoughts, as they seem inconsistent. 

In message #27 *eschultz* , dicusses  a list of "basic issue"s to track.
In message #29 you appear to agree with what he is saying.

The point I am referring to is on the list
https://github.com/prplfoundation/openw … ive/issues
**at:**
https://github.com/prplfoundation/openw … e/issues/2

So, to be clear on what I am proposing is nothing more than a *Guide tothe OpenWrt source tree*

My only questions is where are the source code repositories? wink

Jesse

Hi Jesse,

I guess I'm behind in my reading. I see now that you stepped up for #2 (working with the source tree) on the OpenWrt Doc Initiative. Thanks for doing this!

The source code is in git, and is available at this URL: https://dev.openwrt.org/wiki/GetSource

Best regards,

Rich

The discussion might have continued from here.