diff options
| author | Edward Thomson <ethomson@edwardthomson.com> | 2021-02-25 12:36:39 +0300 |
|---|---|---|
| committer | Gar <gar+gh@danger.computer> | 2021-02-25 21:23:43 +0300 |
| commit | e45242ca0275ab4938723faed8e7391e1209e996 (patch) | |
| tree | 4105c77bf92216f355f7d3a234b21faaec680f5e /.npmignore | |
| parent | b7e37f648552017ee5092d1f2ec0dafbdd2ee265 (diff) | |
chore(docs): add navigation configuration
The documentation in this repository is added to the overall npm
documentation at https://docs.npmjs.com/, which includes both the
documentation for the public registry and the CLI.
The documentation site itself also has a navigational hierarchy;
since the content is included from the CLI, we also want to ensure
that the navigation for that content lives in this repository.
This means that this repository is the source of truth for all of the
CLI documentation, and we do not need to update two places when we
add, edit, or remove CLI documentation. It all lives here.
This also teaches the documentation rendering script to identify when
the navigation configuration (nav.yml) is missing new pages that were
recently added or retains old pages that have recently been deleted.
PR-URL: https://github.com/npm/cli/pull/2775
Credit: @ethomson
Close: #2775
Reviewed-by: @wraithgar
Diffstat (limited to '.npmignore')
| -rw-r--r-- | .npmignore | 1 |
1 files changed, 1 insertions, 0 deletions
diff --git a/.npmignore b/.npmignore index b90057457..d1b1fde3d 100644 --- a/.npmignore +++ b/.npmignore @@ -16,6 +16,7 @@ node_modules/npm-registry-mock # don't need these in the npm package. html/*.png +docs/nav.yml # don't ignore .npmignore files # these are used in some tests. |