Language agnostic documentation for libui? Tutorial?
- Dominant language
- C
- Stars
- 10.9k
- Forks
- 612
- PR merge metrics
- No merged PRs in 30d
Description
Hey there,
Go-related documentation is available here:
https://pkg.go.dev/github.com/andlabs/ui?utm_source=godoc#pkg-constants
But I was thinking ... since there are language bindings to libui, perhaps we
could have a language-agnostic documentation of libui in the long run.
Things that should work across the different languages, e. g. setMargin()
should be the same all across, so it would have to be documented only
once.
Additionally it would be nice to tie such a documentation to examples, aka
make it a bit more like a tutorial.
Contributor guide
Research direction
Start with the linked Go package documentation, then review the available language bindings and examples to identify concepts shared across them. Done means producing an agreed language-agnostic documentation structure with tutorial-style examples, rather than separate language-specific references.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- c, go
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100