docs: doc for ipmfs (#2408)

doc for ipmfs Signed-off-by: suyanhanx <suyanhanx@gmail.com>
apache · Jun 3, 2023 · 6e747a7 · 6e747a7
1 parent 2d2723f
commit 6e747a7
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 16 deletions.
diff --git a/core/src/services/ipmfs/backend.rs b/core/src/services/ipmfs/backend.rs
@@ -33,23 +33,9 @@ use super::writer::IpmfsWriter;
 use crate::raw::*;
 use crate::*;
 
-/// Backend for IPFS service
+/// IPFS Mutable File System (IPMFS) backend.
 ///
-/// # Capabilities
-///
-/// This service can be used to:
-///
-/// - [x] stat
-/// - [x] read
-/// - [x] write
-/// - [ ] create_dir
-/// - [x] delete
-/// - [ ] copy
-/// - [ ] rename
-/// - [x] list
-/// - [ ] scan
-/// - [ ] presign
-/// - [ ] blocking
+#[doc = include_str!("docs.md")]
 #[derive(Clone)]
 pub struct IpmfsBackend {
     root: String,

diff --git a/core/src/services/ipmfs/docs.md b/core/src/services/ipmfs/docs.md
@@ -0,0 +1,15 @@
+## Capabilities
+
+This service can be used to:
+
+- [x] stat
+- [x] read
+- [x] write
+- [ ] create_dir
+- [x] delete
+- [ ] copy
+- [ ] rename
+- [x] list
+- [ ] scan
+- [ ] presign
+- [ ] blocking
diff --git a/website/docs/services/ipmfs.mdx b/website/docs/services/ipmfs.mdx
@@ -0,0 +1,9 @@
+---
+title: IPMFS
+---
+
+IPFS Mutable File System (IPMFS) support
+
+import Docs from "../../../core/src/services/ipmfs/docs.md"
+
+<Docs components={props.components} />