From ecb61490f79958fedf778477cbaa0f27482b7d72 Mon Sep 17 00:00:00 2001
From: Paul Campbell <pcampbell@kemitix.net>
Date: Sun, 3 Nov 2024 20:11:15 +0000
Subject: [PATCH] docs(fs): move checklist/std::fs mapping to rustdoc

---
 README.md     | 20 ++------------------
 src/fs/mod.rs | 21 +++++++++++++++++++++
 2 files changed, 23 insertions(+), 18 deletions(-)

diff --git a/README.md b/README.md
index e08cdc8..92c4436 100644
--- a/README.md
+++ b/README.md
@@ -2,25 +2,9 @@
 
 Provides injectable Filesystem and Network resources to make code more testable.
 
-#### std::fs alternatives
+### Filesystem
 
-- [x] `std::fs::canonicalize` - `path(path).canonicalize()` - Returns the canonical, absolute form of a path with all intermediate components normalized and symbolic links resolved.
-- [x] `std::fs::copy` - `file(path).copy(target)` - Copies the contents of one file to another. This function will also copy the permission bits of the original file to the destination file.
-- [x] `std::fs::create_dir` - `dir(path).create()` - Creates a new, empty directory at the provided path
-- [x] `std::fs::create_dir_all` - `dir(path).create_all()` - Recursively create a directory and all of its parent components if they are missing.
-- [x] `std::fs::hard_link` - `file(path).hard_link(other)` - Creates a new hard link on the filesystem.
-- [x] `std::fs::metadata` - `path(path).metadata()` - Given a path, query the file system to get information about a file, directory, etc.
-- [x] `std::fs::read` - `file(path).reader().bytes()` - Read the entire contents of a file into a bytes vector.
-- [x] `std::fs::read_dir` - `dir(path).read()` - Returns an iterator over the entries within a directory.
-- [ ] `std::fs::read_link` - `link(path).read()` - Reads a symbolic link, returning the file that the link points to.
-- [x] `std::fs::read_to_string` - `file(path).reader().to_string()` - Read the entire contents of a file into a string.
-- [x] `std::fs::remove_dir` - `dir(path).remove()` - Removes an empty directory.
-- [x] `std::fs::remove_dir_all` - `dir(path).remove_all()` - Removes a directory at this path, after removing all its contents. Use carefully!
-- [x] `std::fs::remove_file` - `file(path).remove()` - Removes a file from the filesystem.
-- [x] `std::fs::rename` - `path(path).rename()` - Rename a file or directory to a new name, replacing the original file if to already exists.
-- [ ] `std::fs::set_permissions` - `path(path).set_permissions()` - Changes the permissions found on a file or a directory.
-- [x] `std::fs::symlink_metadata` - `path(path).symlink_metadata()` - Query the metadata about a file without following symlinks.
-- [x] `std::fs::write` - `file(path).write()` - Write a slice as the entire contents of a file.
+Documentation is [here](https://docs.rs/kxio/latest/kxio/fs/).
 
 ### Network
 
diff --git a/src/fs/mod.rs b/src/fs/mod.rs
index 4c27148..ecc3c27 100644
--- a/src/fs/mod.rs
+++ b/src/fs/mod.rs
@@ -26,6 +26,27 @@
 //! # Ok(())
 //! # }
 //! ```
+//!
+//! # Standard library equivalents
+//!
+//! - [x] `std::fs::canonicalize` - `path(path).canonicalize()` - Returns the canonical, absolute form of a path with all intermediate components normalized and symbolic links resolved.
+//! - [x] `std::fs::copy` - `file(path).copy(target)` - Copies the contents of one file to another. This function will also copy the permission bits of the original file to the destination file.
+//! - [x] `std::fs::create_dir` - `dir(path).create()` - Creates a new, empty directory at the provided path
+//! - [x] `std::fs::create_dir_all` - `dir(path).create_all()` - Recursively create a directory and all of its parent components if they are missing.
+//! - [x] `std::fs::hard_link` - `file(path).hard_link(other)` - Creates a new hard link on the filesystem.
+//! - [x] `std::fs::metadata` - `path(path).metadata()` - Given a path, query the file system to get information about a file, directory, etc.
+//! - [x] `std::fs::read` - `file(path).reader().bytes()` - Read the entire contents of a file into a bytes vector.
+//! - [x] `std::fs::read_dir` - `dir(path).read()` - Returns an iterator over the entries within a directory.
+//! - [ ] `std::fs::read_link` - `link(path).read()` - Reads a symbolic link, returning the file that the link points to.
+//! - [x] `std::fs::read_to_string` - `file(path).reader().to_string()` - Read the entire contents of a file into a string.
+//! - [x] `std::fs::remove_dir` - `dir(path).remove()` - Removes an empty directory.
+//! - [x] `std::fs::remove_dir_all` - `dir(path).remove_all()` - Removes a directory at this path, after removing all its contents. Use carefully!
+//! - [x] `std::fs::remove_file` - `file(path).remove()` - Removes a file from the filesystem.
+//! - [x] `std::fs::rename` - `path(path).rename()` - Rename a file or directory to a new name, replacing the original file if to already exists.
+//! - [ ] `std::fs::set_permissions` - `path(path).set_permissions()` - Changes the permissions found on a file or a directory.
+//! - [x] `std::fs::symlink_metadata` - `path(path).symlink_metadata()` - Query the metadata about a file without following symlinks.
+//! - [x] `std::fs::write` - `file(path).write()` - Write a slice as the entire contents of a file.
+//!
 use std::path::PathBuf;
 
 mod dir;