Re: [E-devel] Documentation into the Interfaces era :)

On Wed, 01 Nov 2017 18:27:51 + Andrew Williams said: > Hi, > > Whatever rendering technologies we use within Edi is probably out of scope > for this thread which was (in part) about using a more portable > documentation format to allow folk to access the docs outwith

Re: [E-devel] Documentation into the Interfaces era :)

Hi, Whatever rendering technologies we use within Edi is probably out of scope for this thread which was (in part) about using a more portable documentation format to allow folk to access the docs outwith the E website context. Markdown is working well for the documentation team as they can use

Re: [E-devel] Documentation into the Interfaces era :)

On Tue, 31 Oct 2017 10:01:43 + Andrew Williams said: > Hi > > Ideally yes - but then images are part of the spec anyway - and tables are > pretty standard these days. ok. so then it'd have to be a mixed bag of textblocks/entries + tables or boxes containing them with

Re: [E-devel] Documentation into the Interfaces era :)

Hi Ideally yes - but then images are part of the spec anyway - and tables are pretty standard these days. Andy On Tue, 31 Oct 2017 at 08:37 Carsten Haitzler wrote: > On Tue, 31 Oct 2017 08:18:37 + Andrew Williams > said: > > > In the case of

Re: [E-devel] Documentation into the Interfaces era :)

On Tue, 31 Oct 2017 08:18:37 + Andrew Williams said: > In the case of method/symbol documentation that is indeed correct and no > markup language is my first port of call for that. The first pass was done > with clang which is pretty good thus far - .eo is going to be

Re: [E-devel] Documentation into the Interfaces era :)

In the case of method/symbol documentation that is indeed correct and no markup language is my first port of call for that. The first pass was done with clang which is pretty good thus far - .eo is going to be much more help once the interfaces become more commonly used. However what your email

Re: [E-devel] Documentation into the Interfaces era :)

On Tue, 24 Oct 2017 13:39:14 + Andrew Williams said: > On Tue, 24 Oct 2017 at 13:09 Carsten Haitzler wrote: > > > On Mon, 23 Oct 2017 11:57:56 + Andrew Williams > > said: > > > > > Hi, > > > > > > I will try to provide

Re: [E-devel] Documentation into the Interfaces era :)

On Tue, 24 Oct 2017 at 13:09 Carsten Haitzler wrote: > On Mon, 23 Oct 2017 11:57:56 + Andrew Williams > said: > > > Hi, > > > > I will try to provide as much insight as I can: > > > > As many of the community are aware I started the Edi project to

Re: [E-devel] Documentation into the Interfaces era :)

On Mon, 23 Oct 2017 11:57:56 + Andrew Williams said: > Hi, > > I will try to provide as much insight as I can: > > As many of the community are aware I started the Edi project to help get > people into coding on EFL - the learning curve is very steep and the > tooling

Re: [E-devel] Documentation into the Interfaces era :)

Hi, I will try to provide as much insight as I can: As many of the community are aware I started the Edi project to help get people into coding on EFL - the learning curve is very steep and the tooling was basically commandline based. Documentation is a big part of the solution and we've come a

Re: [E-devel] Documentation into the Interfaces era :)

On Fri, 20 Oct 2017 09:36:29 + Andrew Williams said: > Hi, > > Moving it to the template certainly makes life so we don't have to remember > to add it to every page. It looks from the current status that it should > have been on on /docs and /news - so with the new

Re: [E-devel] Documentation into the Interfaces era :)

On Fri, 20 Oct 2017 08:06:00 +0900 Carsten Haitzler said: > On Thu, 19 Oct 2017 09:41:00 + Andrew Williams > said: > > > Hi, > > > > I see your point but I do not follow. There are various extensions of > > Markdown (PHP Markdown Extra is the

Re: [E-devel] Documentation into the Interfaces era :)

Hi, Moving it to the template certainly makes life so we don't have to remember to add it to every page. It looks from the current status that it should have been on on /docs and /news - so with the new structure I'll pop it on /docs /develop /contrib and /news then - does that meet our

Re: [E-devel] Documentation into the Interfaces era :)

On Thu, 19 Oct 2017 09:41:00 + Andrew Williams said: > Hi, > > I see your point but I do not follow. There are various extensions of > Markdown (PHP Markdown Extra is the one I mentioned which is very similar > to GFM) some of them understand the concept of front

Re: [E-devel] Documentation into the Interfaces era :)

On Thu, 19 Oct 2017 11:01:12 + Andrew Williams said: > Hi, > > I was just looking at our usage of discussions on the website as well. > Outside of news articles I count 11 pages that have it turned on. > Should we have it switched on for all of them or are those 11

Re: [E-devel] Documentation into the Interfaces era :)

Hi, I was just looking at our usage of discussions on the website as well. Outside of news articles I count 11 pages that have it turned on. Should we have it switched on for all of them or are those 11 specifically open for comment? Cheers, Andrew On Thu, 19 Oct 2017 at 10:40 Andrew Williams

Re: [E-devel] Documentation into the Interfaces era :)

Hi, I see your point but I do not follow. There are various extensions of Markdown (PHP Markdown Extra is the one I mentioned which is very similar to GFM) some of them understand the concept of front matter and either try to parse it or ignore it. Some don't. Any Markdown editor that is GFM or

Re: [E-devel] Documentation into the Interfaces era :)

On Thu, 19 Oct 2017 09:28:16 + Andrew Williams said: > Hi, > > I don't understand the hypothetical edit problem - it works here and I see > no issues. Perhaps you can give a concrete example that you are worried > about (i.e. a page we have) and I will check that it

Re: [E-devel] Documentation into the Interfaces era :)

Hi, I don't understand the hypothetical edit problem - it works here and I see no issues. Perhaps you can give a concrete example that you are worried about (i.e. a page we have) and I will check that it works as expected? To satisfy the addition of dokuwiki includes, title etc the plugin

Re: [E-devel] Documentation into the Interfaces era :)

On Wed, 18 Oct 2017 10:34:04 + Andrew Williams said: > Hi, > > When I use "Markdown" I mean those tools that are common in *at least* the > implementation of the core definition at > https://daringfireball.net/projects/markdown/syntax - I do not mean the > concept of a

Re: [E-devel] Documentation into the Interfaces era :)

That’s because we are using dokuwiki format. If we switch then the document about formatting switches... On Wed, 18 Oct 2017 at 23:28, Simon Lees wrote: > > > On 18/10/17 23:18, Andrew Williams wrote: > > Hi, > > > > Given that the syntax info page is included in our content I

Re: [E-devel] Documentation into the Interfaces era :)

On 18/10/17 23:18, Andrew Williams wrote: > Hi, > > Given that the syntax info page is included in our content I don't > understand the question. If we update the documents that people follow then > anyone who is not familiar with MarkDown does as they did before - read the > docs? > Or did I

Re: [E-devel] Documentation into the Interfaces era :)

Hi, > Original Message > Subject: Re: [E-devel] Documentation into the Interfaces era :) > Local Time: October 18, 2017 2:57 AM > UTC Time: October 18, 2017 9:57 AM > From: ras...@rasterman.com > To: Enlightenment developer list <enlightenment-devel@

Re: [E-devel] Documentation into the Interfaces era :)

Hi, Given that the syntax info page is included in our content I don't understand the question. If we update the documents that people follow then anyone who is not familiar with MarkDown does as they did before - read the docs? Or did I miss something? On Wed, 18 Oct 2017 at 12:51 Simon Lees

Re: [E-devel] Documentation into the Interfaces era :)

On 18/10/17 19:47, Andrew Williams wrote: > Hi, > > I am struggling with the factual inaccuracies - phab is not markdown (they > call it "similar to" > https://secure.phabricator.com/book/phabricator/article/remarkup/), trac is > not markdown (it is inspired by previous wikis >

Re: [E-devel] Documentation into the Interfaces era :)

Hi, When I use "Markdown" I mean those tools that are common in *at least* the implementation of the core definition at https://daringfireball.net/projects/markdown/syntax - I do not mean the concept of a simplified text markup. It is trivial to identify if a syntax complies to this and most of

Re: [E-devel] Documentation into the Interfaces era :)

On Wed, 18 Oct 2017 09:17:05 + Andrew Williams said: https://en.wikipedia.org/wiki/Markdown specifically GFM vs commonmark. github call it markdown. stackoverflow's markdown is commonmark. they are not compatible (strikethrough, tables etc.) ... there is no SINGLE

Re: [E-devel] Documentation into the Interfaces era :)

Hi, I am struggling with the factual inaccuracies - phab is not markdown (they call it "similar to" https://secure.phabricator.com/book/phabricator/article/remarkup/), trac is not markdown (it is inspired by previous wikis https://trac.edgewall.org/wiki/WikiFormatting) but all of this is

Re: [E-devel] Documentation into the Interfaces era :)

On Tue, 17 Oct 2017 10:31:34 + Andrew Williams said: > Googling "is dokuwiki markdown?" returns a dokuwiki page stating "Markdown > is a text markup language. So is DokuWiki syntax. Or MediaWiki syntax. > There are similarities but none of them is a dialect of the

Re: [E-devel] Documentation into the Interfaces era :)

Maybe I'm missing something, but the question of whether docuwiki is markdown seems irrelevant to the main points in this thread? The proposal from the initial mail seems good overall. On Tue, Oct 17, 2017 at 6:32 AM Andrew Williams wrote: > Googling "is dokuwiki

Re: [E-devel] Documentation into the Interfaces era :)

Googling "is dokuwiki markdown?" returns a dokuwiki page stating "Markdown is a text markup language. So is DokuWiki syntax. Or MediaWiki syntax. There are similarities but none of them is a dialect of the other". The standards page https://tools.ietf.org/html/rfc7763 lists

Re: [E-devel] Documentation into the Interfaces era :)

On Mon, 16 Oct 2017 09:25:20 + Andrew Williams said: > Hi, > > Unfortunately dokuwiki is not markdown - Well... it is markdown AND markup with an eclectic mix of both. there isn't a single markdown format. every wiki has it's own which is slightly different, but

Re: [E-devel] Documentation into the Interfaces era :)

Hi, Unfortunately dokuwiki is not markdown - https://www.dokuwiki.org/wiki:syntax , what I was proposing moves us to the php extended markdown which is well known and supported by most php based apps if not more. By changing to a standardised format we can have better interoperability and also

Re: [E-devel] Documentation into the Interfaces era :)

On Tue, 10 Oct 2017 17:53:09 + Andrew Williams said: > Hi, > > I am looking at how we should be trying to structure our documentation as > we update for interfaces and slowly move aside the legacy pages. > > I've made this page to summarise my thinking so far -

Re: [E-devel] Documentation into the Interfaces era :)

I've now ensured that all tickets from T5826 are linked into the document so any holes in the proposal are missed tickets I reckon. Any thoughts just shout :) Andy On Wed, 11 Oct 2017 at 11:11 Andrew Williams wrote: > Following a smart suggestion I have moved

Re: [E-devel] Documentation into the Interfaces era :)

Following a smart suggestion I have moved /dev/contribute to /contrib - there will be plenty more in there in the future and it's not really the same as developer guides etc. Rather than just a link to phab which it is at the moment we should put all the "getting started contributing" docs in the

[E-devel] Documentation into the Interfaces era :)

Hi, I am looking at how we should be trying to structure our documentation as we update for interfaces and slowly move aside the legacy pages. I've made this page to summarise my thinking so far - capturing what we should migrate, what we should add and a few items that don't seem to fit yet in