OrchardCMS / OrchardDoc

Documentation for Orchard 1.x (not Orchard Core, for that see https://docs.orchardcore.net/).
http://docs.orchardproject.net
142 stars 242 forks source link

First time mkdocs usage mkdocs.yml does not exist #364

Closed mwpowellhtx closed 2 years ago

mwpowellhtx commented 2 years ago

Followed the instructions, running mkdocs serve from the docs directory, getting the error.

D:\Path\To\OrchardDocs-Trunk\docs>mkdocs serve
INFO     -  Building documentation...
Error: Config file 'mkdocs.yml' does not exist.

The instructions are silent on the subject.

Also, is mkdocs really necessary? i.e. as long as you can browse and have a markdown viewer perhaps a Visual Studio Code or what have you, the paths should just 'be there' and so on?

I'll do some more digging on the topic, but if there are any suggestions, much appreciated, thank you.

agriffard commented 2 years ago

mkdocs.yml is in the parent folder, not in docs.

agriffard commented 2 years ago

You are aware that this is the docs for Orchard 1, not Orchard Core, right?

Skrypt commented 2 years ago

https://github.com/OrchardCMS/OrchardCore/tree/main/src/docs

OrchardCore documentation is part of its main source code repository.

mwpowellhtx commented 2 years ago

mkdocs.yml is in the parent folder, not in docs.

Possibly needs clarification:

Go to the docs folder and run ...

Rather, the repo directory, correct?

I'm a dummy reading the docs. I literally go to the docs folder. 🍻

mwpowellhtx commented 2 years ago

You are aware that this is the docs for Orchard 1, not Orchard Core, right?

Ah, okay...

OrchardCore documentation is part of its main source code repository.

Now I am. Thank you.