[Documentation] Create Documentation

[michaelsakharov]

This is a little while off, maybe after "v1.0" but we will need documentation.

Maybe: https://github.com/McShelby/hugo-theme-relearn

[PaperPrototype]

https://dotnet.github.io/docfx/

[PaperPrototype]

#176 related issue

[PaperPrototype]

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.

• Command Line arguments for prowl #151 (including headless mode and it's CLI args),
• how to create a gameObject,
• how to create a shader,
• how to use the UI.

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

[brmassa]

I've created a DocFX documentation site. It's mostly a Scaffold for the content. I've scanned the development branch to generate the API Reference, and I've put into version 1.0.0 for the sake of testing the layout.

Site: https://brmassa.github.io/prowl-site

Repository: https://github.com/brmassa/prowl-site

[PaperPrototype]

@brmassa nice!

[Ashleycodesseo]

hey @PaperPrototype I'm a newbie REST documentation writer. I'd love to help you all with your documentation and get some experience as well. Let me know what you need so I can give you a hand

[brmassa]

hey @PaperPrototype I'm a newbie REST documentation writer. I'd love to help you all with your documentation and get some experience as well. Let me know what you need so I can give you a hand

@Ashleycodesseo, the API reference is extracted directly from the code. There is a format that the scanner can read.

for example:

    /// <summary>
    /// Entry point of the build command. It will be called by the main program
    /// in case the build command is invoked (which is by default).
    /// </summary>
    /// <param name="options">Command line options</param>
    /// <param name="logger">The logger instance. Injectable for testing</param>
    /// <param name="fs"></param>
    public BuildCommand(BuildOptions options, ILogger logger, IFileSystem fs)
    }

It will generate a page containing this information.

Also, manual and tutorials are needed. But are more in prose form.

[Ashleycodesseo]

@brmassa ok so what would you like me to do? Do you want me to test it myself and create some documentation within the app?

[brmassa]

@Ashleycodesseo suggestion workflow (for anyone that want to help on documenting code):

workflow

• clone/fork the code
• use ChatGPT/Copiliot/Claude/etc to generate comment-documention for bulk of the work for you (note one will use a most of the free daily quota because the classes are really big).
  • review if there is any sense
• compare with the equivalent class in Unity. Consider using similar
• generate a Merge Request. Other devs will read the changes, discuss and eventually accept into the code

what code is priority?

check https://brmassa.github.io/prowl-site/api/1.0.0/Prowl.Editor.html. Almost NO CLASS is properly documented. Anything will help. Focus in an area that you are curious. Use the opportunity to understand/study the code.

What about writing tutorials or guides?

Good too. For this, i suggest to clone https://github.com/brmassa/Prowl-site and work on manual folder. Even if we adopt another system to host the documentation, I will port any documentation created to the new system.

• visit the other engines as referenced in the https://github.com/brmassa/Prowl-site
• try to replicate the tutorials, guides or other material
• screenshots are super welcome, because most users are very visual
• MR against that repo