mirror of
https://github.com/nushell/nushell.git
synced 2025-08-18 14:00:58 +02:00
Add top-level crate documentation/READMEs (#12907)
# Description Add `README.md` files to each crate in our workspace (-plugins) and also include it in the `lib.rs` documentation for <docs.rs> (if there is no existing `lib.rs` crate documentation) In all new README I added the defensive comment that the crates are not considered stable for public consumption. If necessary we can adjust this if we deem a crate useful for plugin authors.
This commit is contained in:
committed by
GitHub
parent
f5bff8c9c8
commit
c5aa15c7f6
5
crates/nu-color-config/README.md
Normal file
5
crates/nu-color-config/README.md
Normal file
@@ -0,0 +1,5 @@
|
||||
Logic to resolve colors for syntax highlighting and output formatting
|
||||
|
||||
## Internal Nushell crate
|
||||
|
||||
This crate implements components of Nushell and is not designed to support plugin authors or other users directly.
|
@@ -1,3 +1,4 @@
|
||||
#![doc = include_str!("../README.md")]
|
||||
mod color_config;
|
||||
mod matching_brackets_style;
|
||||
mod nu_style;
|
||||
|
Reference in New Issue
Block a user