autohelp icon indicating copy to clipboard operation
autohelp copied to clipboard

Do you have any documentation?

Open 4441564944 opened this issue 8 years ago • 3 comments

It seems like a nice project, but I don't know where to start. Your project is mentioned here: https://visualstudiomagazine.com/articles/2017/02/21/vs-dotnet-code-documentation-tools-roundup.aspx

4441564944 avatar Feb 04 '18 17:02 4441564944

Seconded - seems like a great tool but I wasn't able to get this up and running locally in IIS without any documentation. Even some minimal steps for setting this up would be great - or if a docker container could be published to DockerHub that would be great too.

TylerNielsen avatar Sep 21 '18 19:09 TylerNielsen

@uetoyo @TylerNielsen I was able to get the .NET Core version (sorta) working. After cloning the repo, build the AutoHelp.web.netcore project, then run it:

# Change into cloned repo dir
$ cd autohelp/AutoHelp.web.netcore

# Build the project
$ dotnet build AutoHelp.web.netcore.csproj

...project builds...

# Run the server
$ dotnet bin/Debug/netcoreapp2.0/AutoHelp.web.netcore.dll
Hosting environment: Production
Content root path: /home/marsh/repos/autohelp/AutoHelp.web.netcore
Now listening on: http://localhost:5000
Application started. Press Ctrl+C to shut down.

If you then navigate to http://localhost:5000, you should see the UI rendered in your browser.

The wiki says to upload the DLL and XML doc files using the "Manage" section in the UI, but I was unable to get that working. As a workaround, I shut down the server, manually copied my DLL and XML doc file into autohelp/AutoHelp.web.netcore/wwwroot/data, then fired it up again and was able to browse the assembly's docs.

mmacy avatar Dec 28 '18 22:12 mmacy

This project might be dead. Check out an alternative I created last year: Doxie

gordon-matt avatar Sep 12 '19 08:09 gordon-matt