Add /docs project to installation instructions (#2429)

JuliaDocs · Feb 3, 2024 · 9c4fdb0 · 9c4fdb0
1 parent d521d5a
commit 9c4fdb0
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/docs/src/man/guide.md b/docs/src/man/guide.md
@@ -14,6 +14,20 @@ From the Julia REPL, type `]` to enter the Pkg REPL mode and run
 pkg> add Documenter
 ```
 
+For package documentation, the standard approach is to install Documenter into a documentation-specific project stored in the `docs/` subdirectory of your package.
+To do this, navigate to your package's root folder and do
+
+```
+pkg> activate docs/
+
+(docs) pkg> add Documenter
+```
+
+This will create `Project.toml` and `Manifest.toml` files in the `docs/` subdirectory. 
+
+Note that for packages, you also likely need to have your package that you are documenting as a  ["dev dependency"](https://pkgdocs.julialang.org/v1/managing-packages/#developing) of the `docs/` environment.
+
+See also [the Pkg.jl documentation on working with project environments](https://pkgdocs.julialang.org/v1/environments/).
 
 ## Setting up the Folder Structure