Re: [LEDE-DEV] Lede/Openwrt documentation

2017-11-16 Thread Javier Domingo Cansino
Before this thread falls into oblivion, I would like to ask the guys on charge of the docs (I think I got the correct emails) for feedback. The general impression from the list that I have is that there are a lot of doubts on if such a hardcore change in documentation will work, but the benefits s

Re: [LEDE-DEV] Lede/Openwrt documentation

2017-11-12 Thread Javier Domingo Cansino
> But it seems like a) way more hassle than editing a wiki directly and > b) requires a github account. The github account is the same as the wiki account, but I do agree that is more hassle mainly because it's not an integrated experience > I do some stuff with github, but so fa

Re: [LEDE-DEV] Lede/Openwrt documentation

2017-11-12 Thread Javier Domingo Cansino
> Editing the page happens through Github's web editor and web interface, > both are utter garbage for code, and even more so for text-based > documentation. Plus the whole fact that you are required to open a PR, > which is a completely alien concept for non-developers. If someone has an small ch

Re: [LEDE-DEV] Lede/Openwrt documentation

2017-11-12 Thread Javier Domingo Cansino
> The wiki is working for me. it's great to have the ToH. Also the device pages > are great. However the wiki is not always completely correct and may be just > wrong. It's a wiki, change it! A wiki is always changing. Just in case, we are not loosing the ToH, it's just that I didn't implement i

Re: [LEDE-DEV] Lede/Openwrt documentation

2017-11-10 Thread Javier Domingo Cansino
Hello, I have continued working on the docs https://lede.rtfd.io. It now contains a Proof of Concept, with the following features: * Documentation can be exported in different formats, html (hosted in https://lede.rtfd.io), single page html, pdf, ebook etc. * Documentation has been edited in a si

Re: [LEDE-DEV] Lede/Openwrt documentation

2017-11-07 Thread Javier Domingo Cansino
Hello, I haven't been able to open a computer past week, so this is running slower than I thought. I have made it available in https://lede.readthedocs.io/en/latest/ and for now it's just the start + about page. I will keep adding pages until I cover the basics, and send an email when it's more r

Re: [LEDE-DEV] [RFC] A new developper documentation for OpenWrt/LEDE

2017-11-07 Thread Javier Domingo Cansino
Hello Rich, There is another thread with proposals and I am currently working on a documentation migration that since I came back from the openwrt summit has been mostly stalled until today because of my own personal stuff. The thread starts at http://lists.infradead.org/pipermail/lede-dev/2017-O

Re: [LEDE-DEV] Lede/Openwrt documentation

2017-10-30 Thread Javier Domingo Cansino
he migration properly. For now, I believe that because of all the corner cases on linking etc. I will just migrate by hand using a couple of markup conversion scripts + manual editing. If someone is interested in helping with this, please don't hesitate. I will see how much I can do in the

Re: [LEDE-DEV] Lede/Openwrt documentation

2017-10-27 Thread Javier Domingo Cansino
ing -- Javier Domingo Cansino ___ Lede-dev mailing list Lede-dev@lists.infradead.org http://lists.infradead.org/mailman/listinfo/lede-dev

Re: [LEDE-DEV] Lede/Openwrt documentation

2017-10-27 Thread Javier Domingo Cansino
> If you want to use the GH editor, I'd go with markdown. For markdown, > the GH web editor has syntax highlighting and and (more important) a > usable preview mode, for RST all you get is a very simple plain text editor. I think you are right, we can do markdown for now and later change some pag

Re: [LEDE-DEV] Lede/Openwrt documentation

2017-10-27 Thread Javier Domingo Cansino
tory rewrite if we want to keep history, but I would just focus on the latest version, rewriting history later is just git work. Cheers, -- Javier Domingo Cansino ___ Lede-dev mailing list Lede-dev@lists.infradead.org http://lists.infradead.org/mailman/listinfo/lede-dev

Re: [LEDE-DEV] Lede/Openwrt documentation

2017-10-27 Thread Javier Domingo Cansino
> And yes, I'm talking of things I can/will do personally. Is there any way to access all the wiki files? I am doing it manually and its turning out to be quite tedious... =) -- Javier Domingo Cansino ___ Lede-dev mailing list

Re: [LEDE-DEV] Lede/Openwrt documentation

2017-10-27 Thread Javier Domingo Cansino
xample with the current lede docs in sphinx, so that you can see the look and feel I am speaking about. Also, openwrt.readthedocs.org is taken but if we were to make official this proposal, I would contact the current owner or rtd people to get it transferred. Cheers,

Re: [LEDE-DEV] Lede/Openwrt documentation

2017-10-24 Thread Javier Domingo Cansino
> Depends on the direction we will be moving, see above. If I can give my opinion, having little training on openwrt-lede code base specifics, I find the LEDE docs better organized. My contributions were around 2 years ago, and focused on documenting the libs that are used in the core of lede-ope

[LEDE-DEV] Lede/Openwrt documentation

2017-10-24 Thread Javier Domingo Cansino
Hello, I have been reviewing email on the archive about what will happen with openwrt/lede documentation on the remerge, and I couldn't reach any conclusion. Would mind anyone clarifying? Cheers, Javier ___ Lede-dev mailing list Lede-dev@lists.infrade