Skip to content

Commit 2a53464

Browse files
authored
Clean up contributor book (#1153)
* Delete solidly out of date sections * Update `commands.md` in contributor book * Remove contributor book translations * Tweak readme to point to the repo dev docs * Remove translation index (commented out) * Readd sidebar to contributor book
1 parent 92373c0 commit 2a53464

27 files changed

+25
-1197
lines changed

.vuepress/configs/navbar/es.ts

-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@ import type { NavbarConfig } from '@vuepress/theme-default';
22

33
export const navbarEs: NavbarConfig = [
44
{ text: 'Libro', link: '/es/book/' },
5-
// { text: "Libro Colaborador", link: "/es/contributor-book/" },
65
{ text: 'Cookbook', link: '/cookbook/' },
76
{ text: 'Blog', link: '/blog/' },
87
];

.vuepress/configs/navbar/pt-BR.ts

-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@ import type { NavbarConfig } from '@vuepress/theme-default';
22

33
export const navbarPtBR: NavbarConfig = [
44
{ text: 'Livro', link: '/pt-BR/book/' },
5-
// { text: "Livro de Contribuidor", link: "/pt-BR/contributor-book/" },
65
{ text: 'Cookbook', link: '/cookbook/' },
76
{ text: 'Blog', link: '/blog/' },
87
];

.vuepress/configs/sidebar/en.ts

+14-16
Original file line numberDiff line numberDiff line change
@@ -111,22 +111,20 @@ export const sidebarEn: SidebarConfig = {
111111
children: commandCategories,
112112
},
113113
],
114-
// "/contributor-book/": [
115-
// {
116-
// text: "Contributor Book",
117-
// collapsible: false,
118-
// children: [
119-
// "",
120-
// "philosophy",
121-
// "values",
122-
// "commands",
123-
// "streams",
124-
// "metadata",
125-
// "plugins",
126-
// "shells",
127-
// ],
128-
// },
129-
// ],
114+
'/contributor-book/': [
115+
{
116+
text: 'Contributor Book',
117+
link: '/contributor-book/README.md',
118+
collapsible: false,
119+
children: [
120+
'README.md',
121+
'philosophy',
122+
'philosophy_0_80',
123+
'commands',
124+
'plugins',
125+
],
126+
},
127+
],
130128
'/cookbook/': [
131129
{
132130
text: 'Cookbook',

.vuepress/configs/sidebar/es.ts

-13
Original file line numberDiff line numberDiff line change
@@ -30,17 +30,4 @@ export const sidebarEs: SidebarConfig = {
3030
],
3131
},
3232
],
33-
// "/es/contributor-book/": [
34-
// {
35-
// text: "Contributor Book",
36-
// collapsable: false,
37-
// children: [
38-
// "introduccion",
39-
// "filosofia",
40-
// "valores",
41-
// "comandos",
42-
// "metadatos",
43-
// ],
44-
// },
45-
// ],
4633
};

.vuepress/configs/sidebar/pt-BR.ts

-16
Original file line numberDiff line numberDiff line change
@@ -21,20 +21,4 @@ export const sidebarPtBR: SidebarConfig = {
2121
],
2222
},
2323
],
24-
// "/pt-BR/contributor-book/": [
25-
// {
26-
// text: "Contributor Book",
27-
// collapsable: false,
28-
// children: [
29-
// "introdução",
30-
// "filosofia",
31-
// "valores",
32-
// "comandos",
33-
// "streams",
34-
// "metadados",
35-
// "plugins",
36-
// "shells",
37-
// ],
38-
// },
39-
// ],
4024
};

contributor-book/README.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,10 @@ Hello and welcome to the Nushell Contributor Book. Nushell, or Nu as its often c
88

99
Contributing to Nu will require at least some basic programmer experience, and it's helpful to have some experience with Rust. That said, we've had people contribute to Nu who have never written a line of Rust before writing their submission. If you are interested in contributing, there's a growing community of people who would like to help you succeed.
1010

11-
This covers three separate areas:
11+
This aims to cover three separate areas:
1212

1313
1. The Design Philosophy of Nu
1414
1. The Implementation of Nu
15-
1. Best practices of coding for Nu
15+
1. Best practices for coding for Nu
16+
17+
The latter two topics are primarily covered directly in the [Nushell repository](https://github.com/nushell/nushell) in developer documentation crossreferenced from its [`CONTRIBUTING.md` file](https://github.com/nushell/nushell/blob/main/CONTRIBUTING.md).

contributor-book/commands.md

+3-4
Original file line numberDiff line numberDiff line change
@@ -8,17 +8,16 @@ Commands are the building blocks for pipelines in Nu. They do the action of the
88

99
## Internal commands
1010

11-
All commands inside of Nu, including plugins, are internal commands. Internal commands communicate with each other using streams of [Tagged<Value>](https://github.com/nushell/nushell/blob/d30c40b40ebfbb411a503ad7c7bceae8029c6689/crates/nu-source/src/meta.rs#L91) and [ShellError](https://github.com/nushell/nushell/blob/main/crates/nu-errors/src/lib.rs#L179).
11+
All commands inside of Nu, including plugins, are internal commands. Internal commands communicate with each other using [`PipelineData`](https://docs.rs/nu-protocol/latest/nu_protocol/enum.PipelineData.html).
1212

1313
### Signature
1414

15-
Commands use a light typechecking pass to ensure that arguments passed to them can be handled correctly. To enable this, each command provides a Signature which tells Nu:
15+
Commands use a light typechecking pass to ensure that arguments passed to them can be handled correctly. To enable this, each [`Command`](https://docs.rs/nu-protocol/latest/nu_protocol/engine/trait.Command.html) provides a [`Signature`](https://docs.rs/nu-protocol/latest/nu_protocol/struct.Signature.html) which tells Nu:
1616

1717
- The name of the command
1818
- The positional arguments (e.g. in `start x y` the `x` and `y` are positional arguments)
1919
- If the command takes an unbounded number of additional positional arguments (e.g. `start a1 a2 a3 ... a99 a100`)
2020
- The named arguments (e.g. `ansi gradient --fgstart '0x40c9ff'`)
21-
- If the command is a filter or a sink
2221

2322
With this information, a pipeline can be checked for potential problems before it's executed.
2423

@@ -34,7 +33,7 @@ Internal commands communicate with each other using the complete value stream th
3433

3534
### Internal to external
3635

37-
Internal commands that send text to external commands need to have prepared text strings ahead of time. If an object is sent directly to an external command, that is considered an error as there is no way to infer how the structured data should be represented for the external command. The user is expected to either narrow down to a simple data cell or to use one of the file type converters (like `to-json`) to convert the table into a string representation.
36+
Internal commands that send text to external commands need to have prepared text strings ahead of time. If an object is sent directly to an external command, that is considered an error as there is no way to infer how the structured data should be represented for the external command. The user is expected to either narrow down to a simple data cell or to use one of the file type converters (like `to json`) to convert the table into a string representation.
3837

3938
The external command is opened so that its `stdin` is redirected, so that the data can be sent to it.
4039

contributor-book/metadata.md

-21
This file was deleted.

contributor-book/philosophy_0_80.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
title: Philosophy (0.80)
3+
---
4+
15
# Nushell design philosophy
26

37
## Core philosophy

contributor-book/shells.md

-53
This file was deleted.

contributor-book/streams.md

-54
This file was deleted.

contributor-book/values.md

-95
This file was deleted.

es/contributor-book/README.md

-10
This file was deleted.

0 commit comments

Comments
 (0)