From 0c584dc0368ab8f59074cd0ad8b4ef58ad27455a Mon Sep 17 00:00:00 2001 From: jdkato Date: Thu, 11 Jan 2024 12:24:49 -0800 Subject: [PATCH] Fix vocab paths for 3.0 --- content/en/docs/topics/vocab/index.md | 21 ++++++++++++--------- 1 file changed, 12 insertions(+), 9 deletions(-) diff --git a/content/en/docs/topics/vocab/index.md b/content/en/docs/topics/vocab/index.md index 267b6ef..38cfb23 100644 --- a/content/en/docs/topics/vocab/index.md +++ b/content/en/docs/topics/vocab/index.md @@ -57,9 +57,18 @@ without having to re-implement them. ## Folder structure -`Vocab` entries are stored in `/Vocab//` and are then -referenced by `` in `.vale.ini`. For example, consider the following -folder structure: +{{< alert context="info">}} +**Heads up**! + +In versions of Vale prior to 3.0, vocabularies were stored in the +`/Vocab` folder. If you're upgrading from an older version of Vale, +you'll need to move your vocabularies to the new +`/config/vocabularies/` location. +{{< /alert >}} + +Vocabulary entries are stored in `/config/vocabularies//` and +are then referenced by `` in `.vale.ini`. For example, consider the +following folder structure: ```bash $ tree styles @@ -157,9 +166,3 @@ vocabularies are for style *users*: * As a user of styles, vocabularies should be able to replace the use of ignore files completely. - -For example, if you were using `Vale.Spelling` with a `/vocab.txt` -file prior to `v2.3`, you can simply copy the contents of `vocab.txt` into -`/Vocab//accept.txt` and it'll work the same (you may -also want to disable `Vale.Terms` and `Vale.Avoid` to replicate the exact -experience).