Improving the Orchard Core documentation

[barthamark]

Hi everyone,

In the survey we at Lombiq recently ran about the Orchard Core starting experience, the no. 1 request was for better documentation. Many people said the whole documentation could be clearer, easier to follow, and more complete.

We’d like to use this thread to collect ideas for improving the docs across the board.

• Which parts of the current documentation have caused you the most confusion?
• Where did you feel you had to dig into source code, community posts, or trial and error because the docs weren’t enough?
• If you could rewrite one section of the docs, which would it be and what would you add?
• Are there examples, diagrams, or tutorials you wish had been included?
• Do you know of examples of really good documentation from other frameworks that we could learn from?

This could be anything: from clarifying how placements or alternates work, to making workflows more understandable, to adding more real-world examples for queries.

Please share your pain points, ideas, and suggestions here. Over the next couple of weeks we’ll gather input and then start working on updates and proposals for how to make the documentation better for everyone.

And don’t forget to contribute to the recipe brainstorming thread as well.

Thanks for helping us improve Orchard Core!