{"action":"created","issue":{"url":"https://api.github.com/repos/ocornut/imgui/issues/596","repository_url":"https://api.github.com/repos/ocornut/imgui","labels_url":"https://api.github.com/repos/ocornut/imgui/issues/596/labels{/name}","comments_url":"https://api.github.com/repos/ocornut/imgui/issues/596/comments","events_url":"https://api.github.com/repos/ocornut/imgui/issues/596/events","html_url":"https://github.com/ocornut/imgui/issues/596","id":149729958,"number":596,"title":"Documentation Improvements","user":{"login":"mottosso","id":2152766,"avatar_url":"https://avatars.githubusercontent.com/u/2152766?v=3","gravatar_id":"","url":"https://api.github.com/users/mottosso","html_url":"https://github.com/mottosso","followers_url":"https://api.github.com/users/mottosso/followers","following_url":"https://api.github.com/users/mottosso/following{/other_user}","gists_url":"https://api.github.com/users/mottosso/gists{/gist_id}","starred_url":"https://api.github.com/users/mottosso/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/mottosso/subscriptions","organizations_url":"https://api.github.com/users/mottosso/orgs","repos_url":"https://api.github.com/users/mottosso/repos","events_url":"https://api.github.com/users/mottosso/events{/privacy}","received_events_url":"https://api.github.com/users/mottosso/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":2,"created_at":"2016-04-20T10:33:26Z","updated_at":"2016-04-20T11:55:00Z","closed_at":null,"body":"Hi @ocornut,\r\n\r\nI'd like to contribute Getting Started documentation for imgui via the [imgui wiki](https://github.com/ocornut/imgui/wiki).\r\n\r\nI've already taken the liberty of refactoring its layout but wanted to check with you whether you would mind or have any preferences on future layout and included documentation.\r\n\r\nWhat I'd like to cover primarily is:\r\n\r\n- [ ] Build instructions for common compilers, such as cl.exe and clang.\r\n- [ ] Minimal, but complete, examples using common window libraries, such as glfw3\r\n\r\nAnd eventually, fully transfer the documentation currently hiding in the source file."},"comment":{"url":"https://api.github.com/repos/ocornut/imgui/issues/comments/212395601","html_url":"https://github.com/ocornut/imgui/issues/596#issuecomment-212395601","issue_url":"https://api.github.com/repos/ocornut/imgui/issues/596","id":212395601,"user":{"login":"mottosso","id":2152766,"avatar_url":"https://avatars.githubusercontent.com/u/2152766?v=3","gravatar_id":"","url":"https://api.github.com/users/mottosso","html_url":"https://github.com/mottosso","followers_url":"https://api.github.com/users/mottosso/followers","following_url":"https://api.github.com/users/mottosso/following{/other_user}","gists_url":"https://api.github.com/users/mottosso/gists{/gist_id}","starred_url":"https://api.github.com/users/mottosso/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/mottosso/subscriptions","organizations_url":"https://api.github.com/users/mottosso/orgs","repos_url":"https://api.github.com/users/mottosso/repos","events_url":"https://api.github.com/users/mottosso/events{/privacy}","received_events_url":"https://api.github.com/users/mottosso/received_events","type":"User","site_admin":false},"created_at":"2016-04-20T11:55:00Z","updated_at":"2016-04-20T11:55:00Z","body":"> How would that differ from the existing code in examples/opengl_example/ ?\r\n\r\nI'm looking for an example with as few lines as possible, in a single source file, for testing whether or not the system can actually run the library, and less about how to actually use it.\r\n\r\n> We can also strive to improve those example as I'm definitively not happy with how they build, but it's not a trivial problem to solve with multi-platform into the equation, lots of devil in the details. \r\n\r\nGlad to hear that. I understand it's tricky to stay generic and please everyone, but I find that it's a lot better to provide at least 1 way of doing things in full, whether that assumes glfw or what not, than to not provide any.\r\n\r\nI would suggest we take a stand on the libraries used in the guide(s) and then stay consistent with those. Having examples also stay true to the those assumptions.\r\n\r\nWhat do you think?\r\n\r\n> For actual function documentations, I would like them to be generated and that topic has some ideas about it.\r\n\r\nAre you thinking along the lines of Doxygen? For many projects I think it makes the most sense, but can I propose an alternative? I think that since imgui is an open source project with lots of potential contributors, it might make more sense instead keeping documentation simple and making contributing to it as simple as possible.\r\n\r\nYou could use something like [GitBook](http://gitbook.com/).\r\n\r\nIf you make it simple to fix mistakes and append both guides and reference material, I think the docs would be much more alive, complete and accurate than it could ever be if automatically built.\r\n\r\nHere's an example of how I envision things.\r\n\r\n- https://mottosso.gitbooks.io/cinder/content/\r\n\r\nThey can also be versioned and given a custom dns, along with statically built and hosted on GitHub Pages.\r\n\r\n- http://api.pyblish.com/\r\n\r\n> There's definitively a lot to do there as ImGui will slowly head into becoming more of a community\r\n\r\nI'd be happy to setup [Discourse](https://www.discourse.org/) for you, hosting is $5/month on DigitalOcean. I think it could really spark collaboration and create a persistent knowledge base. It's also useful for what you might normally use a blog for; such as release notes or news."}}