Skip to content

Commit 41e442e

Browse files
committed
docs: migration guide for .navigation.yml
resolves #3092
1 parent 687a9ba commit 41e442e

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

docs/content/docs/1.getting-started/4.migration.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -151,3 +151,14 @@ Many `ProsePre` components are thin wrappers around the `ProseCode` component. W
151151

152152
1. Your current `ProseCode` logic should be moved to `ProsePre`
153153
2. Rename your `ProseCodeInline` components to `ProseCode`
154+
155+
## `_dir.yml` files are renamed to `.navigation.yml`
156+
157+
In Content v3, we renamed `_dir.yml` to `.navigation.yml`. The new name better reflects the purpose of these files.
158+
Module uses these files to gather information about directories for generating navigation.
159+
160+
Note that in order to make these files available for Module, youe should define your collection's source in
161+
a way that includes these files. For example `source: '**'` and `source: '**/*.{md|yml}` will include these files
162+
in collection, but `source: '**/*.md'` will not include them.
163+
164+

0 commit comments

Comments
 (0)