Skip to content

combined docs #131

@orangecms

Description

@orangecms

So far, we are looking into Rust docs deployment - see #85.
There are additional docs with graphs and other images that Rustdoc is not really made for, which could be built with e.g. mdBook.

We could somehow put mdBook and Rust Docs side-by-side, à la:

  • apis/ for Rustdoc
  • docs/ for mdBook

How do we link one to the other?
A hardcoded (relative) Markdown link would be good enough, probably.

There is a hint here:
https://github.com/peaceiris/actions-gh-pages?tab=readme-ov-file#%EF%B8%8F-mdbook-rust

put ./target/doc/ to your ./book/src dir before you mdbook build

Related:

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions