core-crypto
core-crypto copied to clipboard
Tooling: Bindings docs
- Expand documentation to FFI bindings
- Study automatic foreign language bindings documentation through a process similar to:
- Create a dummy rust module
- Use the platform specific documentation generator to somehow get a Markdown file
- [ ] Swift: Swift-DocC
- [x] Kotlin: Dokka
- [x] TypeScript: TypeDoc
- Include this MD file with
#[doc = include_str!("my_markdown_file.md")]in the dummy module - Let
rustdocdo the rest
New strategy:
- Generate rustdocs
- For each platform specific documentation tool:
- generate docs
- overwrite the empty rustdocs with the generated docs mini-site
- Upload the whole thing to gh-pages branch