{"action":"created","issue":{"url":"https://api.github.com/repos/cybersonic/luceedocs/issues/27","labels_url":"https://api.github.com/repos/cybersonic/luceedocs/issues/27/labels{/name}","comments_url":"https://api.github.com/repos/cybersonic/luceedocs/issues/27/comments","events_url":"https://api.github.com/repos/cybersonic/luceedocs/issues/27/events","html_url":"https://github.com/cybersonic/luceedocs/issues/27","id":59208512,"number":27,"title":"Discussion: What data formats / structure best facilitate collaborative documentation","user":{"login":"DominicWatson","id":471162,"avatar_url":"https://avatars.githubusercontent.com/u/471162?v=3","gravatar_id":"","url":"https://api.github.com/users/DominicWatson","html_url":"https://github.com/DominicWatson","followers_url":"https://api.github.com/users/DominicWatson/followers","following_url":"https://api.github.com/users/DominicWatson/following{/other_user}","gists_url":"https://api.github.com/users/DominicWatson/gists{/gist_id}","starred_url":"https://api.github.com/users/DominicWatson/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/DominicWatson/subscriptions","organizations_url":"https://api.github.com/users/DominicWatson/orgs","repos_url":"https://api.github.com/users/DominicWatson/repos","events_url":"https://api.github.com/users/DominicWatson/events{/privacy}","received_events_url":"https://api.github.com/users/DominicWatson/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":19,"created_at":"2015-02-27T09:09:03Z","updated_at":"2015-02-27T16:11:44Z","closed_at":null,"body":"This is more of a space for discussion / input gathering than an \"issue\" as such. What I think the considerations are:\r\n\r\n* One source of documentation\r\n* Ability to export, with as little effort as possible, to multiple formats (PDF, HTML, Dash, ePub, MOBI, raw JSON...)\r\n* Ability to import from Lucee source to build the *reference* base of the docs\r\n* Ability for contributers to *easily* contribute to the wording and code samples of the documentation, these edits should not be overwritten by reference imports\r\n\r\nI already kicked off my own thoughts on here https://github.com/DominicWatson/luceedocsbuilder but there wasn't really a sensible space for feedback, hence this GH issue.\r\n\r\nMy preference is for tags and functions to have their own editorial source *folder*. In it, could be a number of things:\r\n\r\n    /editorial\r\n        /functions\r\n            /abs\r\n                /examples\r\n                /arguments\r\n                description.md\r\n                references.json\r\n                README.md <-- auto built contribution guidelines describing the structure of the folder and where to look to edit stuff\r\n\r\nI'm in two minds re \"description.md\", and I understand your preference for a `.json` source (that could contain both description of the function/tag + its arguments + other things).\r\n\r\nEither way, I think the folder approach works well as it makes potential future enhancements easier to manage (thinking of multiple contexts of tags and functions for example).\r\n\r\nFeel free to close if you think there is a better space for this.\r\n\r\nD"},"comment":{"url":"https://api.github.com/repos/cybersonic/luceedocs/issues/comments/76419934","html_url":"https://github.com/cybersonic/luceedocs/issues/27#issuecomment-76419934","issue_url":"https://api.github.com/repos/cybersonic/luceedocs/issues/27","id":76419934,"user":{"login":"cybersonic","id":148252,"avatar_url":"https://avatars.githubusercontent.com/u/148252?v=3","gravatar_id":"","url":"https://api.github.com/users/cybersonic","html_url":"https://github.com/cybersonic","followers_url":"https://api.github.com/users/cybersonic/followers","following_url":"https://api.github.com/users/cybersonic/following{/other_user}","gists_url":"https://api.github.com/users/cybersonic/gists{/gist_id}","starred_url":"https://api.github.com/users/cybersonic/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/cybersonic/subscriptions","organizations_url":"https://api.github.com/users/cybersonic/orgs","repos_url":"https://api.github.com/users/cybersonic/repos","events_url":"https://api.github.com/users/cybersonic/events{/privacy}","received_events_url":"https://api.github.com/users/cybersonic/received_events","type":"User","site_admin":false},"created_at":"2015-02-27T16:11:44Z","updated_at":"2015-02-27T16:11:44Z","body":"Here is my first pass at converting tags and functions to the new model, now I need to do that for object functions (member functions) \r\nhttps://github.com/cybersonic/lucee-docpack/tree/4.5.1.000\r\n"}}