search

fzyzcjy / flutter_rust_bridge

Flutter/Dart <-> Rust binding generator, feature-rich, but seamless and simple.
https://fzyzcjy.github.io/flutter_rust_bridge/
MIT License
4.12k stars 283 forks source link

[Bug] Broken links in the docs #731

Closed Roms1383 closed 1 year ago

Roms1383 commented 1 year ago

Describe the bug

I was reading the docs and realized some intra links are broken. Apparently this is related to well-known issue with mdbook and turns out that links from subfolders are not generated when not referenced in SUMMARY.md.

People also pointed out to mdbook-linkcheck which I gave a quick try and indeed shows the broken links (it could probably be a nice addition to the CI).

Codegen logs with RUST_LOG=debug environment variable

_unrelated_

To Reproduce

For example in Simple correspondence when clicking on the link at the bottom of the page.

Same issue confirmed when generating the book locally.

Expected behavior

No response

Generated binding code

No response

OS

No response

Version of flutter_rust_bridge_codegen

No response

Flutter info

No response

Version of clang++

No response

Version of ffigen

No response

Additional context

I haven't filled most of the fields above since it's purely related to mdbook, from content generated locally or in the CI. So the local context doesn't really matter here.

Roms1383 commented 1 year ago

It's a good first issue, if someone wants to get started. Otherwise I'll address it later.

fzyzcjy commented 1 year ago

Looks great, we may

thomas725 commented 1 year ago

I'm unsure if this is related but no matter what link to what docs page I try to open, I always get 404 errors now. I believe they still worked a few days ago: For example: https://fzyzcjy.github.io/flutter_rust_bridge/ http://cjycode.com/flutter_rust_bridge/template/setup_web.html

fzyzcjy commented 1 year ago

@thomas725 That's a big problem #741

Roms1383 commented 1 year ago

Did I break something?! It was supposed to fix it 😅

fzyzcjy commented 1 year ago

Well reverting that PR makes doc work now, so I guess it does accidentically break sth

Roms1383 commented 1 year ago

Ok I'll look into it 👌 Sorry for the inconvenience

fzyzcjy commented 1 year ago

That's OK!

stale[bot] commented 1 year ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

github-actions[bot] commented 1 year ago

This thread has been automatically locked since there has not been any recent activity after it was closed. If you are still experiencing a similar issue, please open a new issue.