-
Notifications
You must be signed in to change notification settings - Fork 614
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Master issue for documentation and examples #317
Comments
So far I have got along fine with the examples and comments in Thanks. |
I forget what my problem with cldoc was at first. My problem with the other tools that exist was their strict formatting rules. I originally wanted something like godoc but with Markdown pages. I wonder if having entirely separate documentation would work too... But sure, I can take a second look at cldoc. @d3dave https://en.wikipedia.org/wiki/Nonzero-rule (though that might be a bit more advanced — example images on various drawing APIs might be a bit more clear) |
Hello awesome people, is the tool for creating documentation now defined? can one contribute in writing documentation? are the fundamentals prepared for that? thanks :-) |
I've taken a different approach entirely. Check the I really need to be better at communicating what my mental process is to everyone here so they can possibly help develop the branch, but first I wonder if I even know how or not |
Hi Pietro, all, I am personally following your work on libui and I hope you will succeed with the remodel branch. Please don't hesitate to communicate in any way so that people can contribute to the project, if not with the code, at least with the documentation or other things. I think it would be beneficial for libui to gather some community around the project to infuse it with some additional momentum. |
I think many people at this point are interested in libui. So far I think libui is not in a bad state at all; I think |
I think a community will form "on its own" when people notice that libui brings definitive advantages |
libui is not yet well-documented. I started fixing this with utflib-and-attrstr, but we still have a while to go.
I have yet to find a documentation system I'm happy with. I am intending on writing my own, but am not sure when (if) that will happen again (since my first attempt didn't go smoothly; and even then I would need copyright clearance to continue working on it).
Ideally the documentation system should be similar to godoc with the addition of Markdown-formatted articles alongside the documentation and as Overview sections on each page.
The Go package ui already has somewhat better documentation I should try to integrate with libui somehow. A way to automatically propagate documentation to package ui would be a pipe dream.
The Go code is devoid of examples, and the API changes means old examples people still turn to don't work.
I'm not sure what problems people have with the documentation and examples that are there on both repositories, but that's also worth addressing.
I also need to figure out what to do about the wikis on GitHub.
The text was updated successfully, but these errors were encountered: