core-crypto icon indicating copy to clipboard operation
core-crypto copied to clipboard

Tooling: Bindings docs

Open OtaK opened this issue 3 years ago • 1 comments

  • Expand documentation to FFI bindings
  • Study automatic foreign language bindings documentation through a process similar to:
    1. Create a dummy rust module
    2. Use the platform specific documentation generator to somehow get a Markdown file
      • [ ] Swift: Swift-DocC
      • [x] Kotlin: Dokka
      • [x] TypeScript: TypeDoc
    3. Include this MD file with #[doc = include_str!("my_markdown_file.md")] in the dummy module
    4. Let rustdoc do the rest

OtaK avatar Jul 20 '22 15:07 OtaK

New strategy:

  1. Generate rustdocs
  2. For each platform specific documentation tool:
    • generate docs
    • overwrite the empty rustdocs with the generated docs mini-site
  3. Upload the whole thing to gh-pages branch

OtaK avatar Aug 08 '22 16:08 OtaK