search

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

More focus needed on documentation #361

Closed RaisinBread42 closed 3 years ago

RaisinBread42 commented 3 years ago

As much as I love the this project, I find that a lot of documentation is missing for various components like modules, recipes in depth, structure/relationship of databases, using work flows, debugging them, building modules to add a workflow event, how to check and access injected services on StartUp from other modules, etc. On top of these, running the code generation CLI template for modules creates a module that targets netstandard2.0.... we are to be targeting core.... quite discouraging for such a promising project.

Although I am beginning to find my way around by looking at the code itself, it is quite hard to get started initially, and really it discourages a developer like myself from investing into orchardcore simply to a lack of documentation. In speaking to my team, they too are discouraged by lack of documentation!

Nonetheless I believe this project has huge potential, but documentation is a must to improve on for it to be more widely adopted. Don't mind helping out myself, but don't know the process/rules you all have for deciding what next to document. Only using this right now as POC for a project we have internally at work. and not yet sure if we will adopt orchardcore.

agriffard commented 3 years ago

Wrong repository, please use https://github.com/OrchardCMS/OrchardCore