-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
[Docs] use GitHub Pages to generate the documentation #1561
Comments
If we did this, then maybe there's a vanity URL Joel has that could be assigned to it (like PollyTalk). |
cc @joelhulen |
I am looking into this. I think the best way would be to use Docfx. It supports notes and also can generate API docs page. |
I have working prototype, there are still some non-functional links and I have not yet solved the links from documentation to api documentation/code. But it should be enough to provide an idea and possibly get some feedback on it: |
Look super cool! Exiting we also have API docs too. I see that some content/organization changes were made. Can you create a PR with just those against the main repo? |
I tried the GitHub pages to generate the docs we have in the
/docs
folder:https://martintmk.github.io/Polly/
This is just very simple case, we can add more customization and nicer themes to it. Could help with having our docs easier to consume.
Will help with #1091
The text was updated successfully, but these errors were encountered: