Mention necessary . -> - replacement for intro vignette

r-lib · May 10, 2023 · 5807199 · 5807199
1 parent 44c92aa
commit 5807199
Showing 1 changed file with 1 addition and 1 deletion.
diff --git a/man/rmd-fragments/navbar-configuration.Rmd b/man/rmd-fragments/navbar-configuration.Rmd
@@ -13,7 +13,7 @@ navbar:
 
 It makes use of the the six built-in components:
 
--   `intro`: "Get Started", which links to a vignette with the same name as the package.
+-   `intro`: "Get Started", which links to a vignette with the same name as the package. Note that dots (`.`) in the package name need to be replaced by hyphens (`-`) in the vignette filename to be recognized as the intro.
 -   `reference`, if there are any `.Rd` files.
 -   `articles`, if there are any vignettes or articles.
 -   `tutorials`, if there any tutorials.