ProwlEngine / Prowl

An Open Source C# 3D Game Engine under MIT license, inspired by Unity and featuring a complete editor
MIT License
451 stars 38 forks source link

Prowl Manual/Guides #176

Closed PaperPrototype closed 2 months ago

PaperPrototype commented 2 months ago

Is your feature request related to a problem? Please describe. I am having trouble keeping up with all the new changes and how they work. It would be nice to have somewhere we can internally document Prowl and all the features we are adding. eg.

Describe the solution you'd like inside of the Prowl repository I can make a manual/ or doc/ or guides/ directory with .md files that deploy as a VitePress site and have it automatically publish any pushes to development and main (with separate sites for each branch)

Describe alternatives you've considered We are already considering using docfx for API docs but a manual with guides documenting non-API related things would be nice.

Additional context VitePress site Currently at https://prowl.pages.dev

PaperPrototype commented 2 months ago

Oh we also currently have some gitbook docs, but it looks like they are unused atm @michaelsakharov do you have a link to those?

michaelsakharov commented 2 months ago

This is the same as the create docs one :P there's no docs yet and won't be for a little while. I would also rather the docs be in another repo.

Can you move this to be a comment to the other issue?