liveview-native / liveview-native/liveview-native-core
Publish Docs for uniffi binding someplace
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 166
- Forks
- 14
- PR merge metrics
- No merged PRs in 30d
Description
In #160, I added a [`cargo make uniffi-swift-docs-macos`](https://github.com/liveview-native/liveview-native-core/blob/b827b1b8b12403d9d6e3541e84c421b76a356b8d/Makefile.toml#L542-L560). This spits out documentation that looks similar to [xcode official documentation](https://developer.apple.com/documentation/xcode).
Let's put this someplace useful. Most elixir projects use https://hexdocs.pm/
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with Makefile.toml lines 542-560 and run cargo make uniffi-swift-docs-macos to inspect the generated binding documentation. Research a suitable public home for these Xcode-style docs, then confirm the work is done when the generated Swift documentation is published there and discoverable.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust, swift
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100