Merge pull request #134 from unfoldtoolbox/better_readme

Updated "Adding documentation" section in the README
unfoldtoolbox · Oct 30, 2023 · 9c952e0 · 9c952e0
2 parents 5b0b6a7 + fc3a9ec
commit 9c952e0
Showing 1 changed file with 3 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -117,9 +117,9 @@ You are very welcome to raise issues and start pull requests!
 
 ### Adding Documentation
 
-1. We recommend to write a Literate.jl document and place it in `docs/_literate/FOLDER/FILENAME.jl` with `FOLDER` being `HowTo`, `Explanation`, `Tutorial` or `Reference` ([recommended reading on the 4 categories](https://documentation.divio.com/)).
-2. Literate.jl converts the `.jl` file to a `.md` automatically and places it in `doc/src/_literate/FILENAME.jl`.
-3. Edit [make.jl](https://github.com/unfoldtoolbox/Unfold.jl/blob/main/docs/make.jl) with a reference to `doc/src/_literate/FILENAME.jl`
+1. We recommend to write a Literate.jl document and place it in `docs/literate/FOLDER/FILENAME.jl` with `FOLDER` being `HowTo`, `Explanation`, `Tutorial` or `Reference` ([recommended reading on the 4 categories](https://documentation.divio.com/)).
+2. Literate.jl converts the `.jl` file to a `.md` automatically and places it in `doc/src/generated/FILENAME.jl`.
+3. Edit [make.jl](https://github.com/unfoldtoolbox/Unfold.jl/blob/main/docs/make.jl) with a reference to `doc/src/literate/FILENAME.jl`
 
 ## Contributors (alphabetically)