- User Since
- Oct 16 2017, 6:10 AM (122 w, 5 d)
Jan 2 2018
Jan 1 2018
Automated TOC and manual navigation boxouts now in place; closing.
Dec 13 2017
Dec 11 2017
@ajwillia.ms Text is up to date, too, everywhere *except* the Clouseau page - which is drastically incomplete. @pbrown66 has a better Clouseau guide on his to-do list which will replace the existing abortive attempt - so there's no point tweaking that page further or replacing the screenshots.
Dec 8 2017
Dec 1 2017
@cedric: So, move the current /develop/efl/start to /develop/legacy/start, then create a new landing page for /develop/efl/start - do I have that right?
@cedric: /contrib/devs/start.md doesn't cover any of the points in the ticket (history, "point to the other introduction", general overview, light idea of where they are going, emphasise it's not limited to Linux nor the desktop, EFL stack has been built with portability and scalability in mind) - it's literally just a guide on how to contribute code.
@cedric: Do you mean that https://www.enlightenment.org/docs/efl/start should be moved to https://www.enlightenment.org/develop/legacy/start.md - and, if so, what should be in /docs/efl/start in its place?
@cedric I've ported documentation for EFL app debugging, but it needs a serious rework. I've tidied the English and formatting, but the examples need looking at to see if they're still relevant to the new API - and the documents themselves end very abruptly without really telling you how to use the tools, just providing a couple of examples apiece.
Nov 29 2017
Nov 28 2017
Nov 22 2017
Ecoding now integrated into the /contrib/devs landing page.
Eina Programming Guide live and ready for review:
Nov 9 2017
The following are entirely undocumented in the present Eina Programming Guide; if documentation is required, example code will need producing for each.
Nov 6 2017
Coding Conventions now in the /contrib/devs/ namespace of DokuWiki:
Nov 3 2017
Arcanist Guide now in the /contrib/devs/ namespace of DokuWiki:
Git Guide now in the /contrib/devs/ namespace of DokuWiki:
This is now live in the /contrib/docs namespace of DokuWiki as the Enlightenment Document Contribution Guide:
Oct 30 2017
Re-opening as per discussion with @ajwillia.ms on IRC.
Multi-language support will be achieved by having language-specific sections, as per the documentation structure plan: https://phab.enlightenment.org/w/doc_system/doc_structure/ - which means there's no need to work on a Roseeta
Draft documentation documentation near-completion; awaiting discussion with team members on the layout of the tutorial template and correct directory layouts beneath the top level.
Completed and discussed on the mailing list and IRC, with conclusions inserted into the documentation guide for later publication.
As achieving this would be non-trivial in DokuWiki, shifting toward near-impossible if we want to retain full Markup portability, the box-out is officially ditched in favour of mandatory sections to the body text covering the same information.
Oct 25 2017
Oct 24 2017
Personally, I think this is a must-have and a big chunk of what makes the Tizen docs so friendly - but I'm willing to be convinced otherwise on a variety of grounds, up to and including "doing this in DokuWiki would be a monumental pain in the you-know-where."
Oct 23 2017
Added the following to the Style Guide:
An important aspect of the Tizen documentation is the navigability, which stands in stark contrast to complaints of the EFL documentation that it's easy to get lost and difficult to find things.
Added information gleaned from the Tizen approach to the draft Style Guide. Appropriate section reproduced below:
Initial analysis published to the efl-technical-documentation mailing list, reproduced below for posterity.
Created an overlay designed to offer insight into the layout and approach taken by the Tizen EFL documentation team:
Oct 17 2017
I spent a chunk of yesterday installing EFL from source onto an Ubuntu 16.04.3 LTS virtual machine and took notes during the process, so unless @pbrown66 is particularly keen on taking that one on it would probably make sense for me to start there (because I'm effectively already done bar the shouting!)