Restore docs CI checks and fix all doc lints (#4204)

This commit is contained in:
Evan Almloff authored and GitHub committed 2025-05-26 19:50:51 +01:00
1 parent 9027ffc278
commit ee3b45af49
57 files changed
+120 -130

No files matched your search

+1 -1
View File
@@ -1140,7 +1140,7 @@ We checked the folder: {}
/// - If the app fails to launch, errors are logged for debugging purposes.
///
/// # Resources:
/// - https://developer.android.com/studio/run/emulator-commandline
/// - <https://developer.android.com/studio/run/emulator-commandline>
async fn open_android_sim(
&self,
root: bool,
+2 -2
View File
@@ -415,7 +415,7 @@ fn create_native_jump_table(
/// It doesn't seem like we can compile the base module to export these, sadly, so we're going
/// to manually satisfy them here, removing their need to be imported.
///
/// https://github.com/WebAssembly/tool-conventions/blob/main/DynamicLinking.md
/// <https://github.com/WebAssembly/tool-conventions/blob/main/DynamicLinking.md>
fn create_wasm_jump_table(patch: &Path, cache: &HotpatchModuleCache) -> Result<JumpTable> {
let name_to_ifunc_old = &cache.symbol_ifunc_map;
let old = &cache.old_wasm;
@@ -1299,7 +1299,7 @@ pub fn prepare_wasm_base_module(bytes: &[u8]) -> Result<Vec<u8>> {
///
/// Uses the heuristics from the wasm-bindgen source code itself:
///
/// https://github.com/rustwasm/wasm-bindgen/blob/c35cc9369d5e0dc418986f7811a0dd702fb33ef9/crates/cli-support/src/wit/mod.rs#L1165
/// <https://github.com/rustwasm/wasm-bindgen/blob/c35cc9369d5e0dc418986f7811a0dd702fb33ef9/crates/cli-support/src/wit/mod.rs#L1165>
fn name_is_bindgen_symbol(name: &str) -> bool {
name.contains("__wbindgen_describe")
|| name.contains("__wbindgen_externref")
+5 -5
View File
@@ -55,7 +55,7 @@
//!
//! Currently, we defer most of our deploy-based bundling to Tauri bundle, though we should migrate
//! to just bundling everything ourselves. This would require us to implement code-signing which
//! is a bit of a pain, but fortunately a solved process (https://github.com/rust-mobile/xbuild).
//! is a bit of a pain, but fortunately a solved process (<https://github.com/rust-mobile/xbuild>).
//!
//! ## Build Structure
//!
@@ -107,7 +107,7 @@
//!
//! ### Linux:
//!
//! https://docs.appimage.org/reference/appdir.html#ref-appdir
//! <https://docs.appimage.org/reference/appdir.html#ref-appdir>
//! current_exe.join("Assets")
//! ```
//! app.appimage/
@@ -157,7 +157,7 @@
//! drive the kotlin build ourselves. This would let us drop gradle (yay! no plugins!) but requires
//! us to manage dependencies (like kotlinc) ourselves (yuck!).
//!
//! https://github.com/WanghongLin/miscellaneous/blob/master/tools/build-apk-manually.sh
//! <https://github.com/WanghongLin/miscellaneous/blob/master/tools/build-apk-manually.sh>
//!
//! Unfortunately, it seems that while we can drop the `android` build plugin, we still will need
//! gradle since kotlin is basically gradle-only.
@@ -309,8 +309,8 @@
//! The idea here is that we can run any of the programs in the same way that they're deployed.
//!
//! ## Bundle structure links
//! - apple: <https>://developer.apple.com/documentation/bundleresources/placing_content_in_a_bundle>
//! - appimage: <https>://docs.appimage.org/packaging-guide/manual.html#ref-manual>
//! - apple: <https://developer.apple.com/documentation/bundleresources/placing_content_in_a_bundle>
//! - appimage: <https://docs.appimage.org/packaging-guide/manual.html#ref-manual>
//!
//! ## Extra links
//! - xbuild: <https://github.com/rust-mobile/xbuild/blob/master/xbuild/src/command/build.rs>
+1 -1
View File
@@ -8,7 +8,7 @@ use tokio::process::Command;
/// The tools for Android (ndk, sdk, etc)
///
/// https://gist.github.com/Pulimet/5013acf2cd5b28e55036c82c91bd56d8?permalink_comment_id=3678614
/// <https://gist.github.com/Pulimet/5013acf2cd5b28e55036c82c91bd56d8?permalink_comment_id=3678614>
#[derive(Debug, Clone)]
pub(crate) struct AndroidTools {
pub(crate) sdk: Option<PathBuf>,