Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Do you have any documentation? #7

Open
4e1e0603 opened this issue Feb 4, 2018 · 3 comments
Open

Do you have any documentation? #7

4e1e0603 opened this issue Feb 4, 2018 · 3 comments

Comments

@4e1e0603
Copy link

4e1e0603 commented Feb 4, 2018

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

@TylerNielsen
Copy link

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.

@mmacy
Copy link

mmacy commented Dec 28, 2018

@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.

@gordon-matt
Copy link

gordon-matt commented Sep 12, 2019

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants