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

[Docs] use GitHub Pages to generate the documentation #1561

Closed
martintmk opened this issue Sep 7, 2023 · 5 comments · Fixed by #1593
Closed

[Docs] use GitHub Pages to generate the documentation #1561

martintmk opened this issue Sep 7, 2023 · 5 comments · Fixed by #1593
Assignees
Labels
documentation v8 Issues related to the new version 8 of the Polly library.
Milestone

Comments

@martintmk
Copy link
Contributor

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

@martincostello
Copy link
Member

If we did this, then maybe there's a vanity URL Joel has that could be assigned to it (like PollyTalk).

@martintmk
Copy link
Contributor Author

If we did this, then maybe there's a vanity URL Joel has that could be assigned to it (like PollyTalk).

cc @joelhulen

@adamnova
Copy link
Contributor

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.

@adamnova
Copy link
Contributor

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:

https://adamnova.github.io/Polly

@martintmk
Copy link
Contributor Author

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:

https://adamnova.github.io/Polly

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?

@adamnova adamnova mentioned this issue Sep 12, 2023
4 tasks
@martintmk martintmk mentioned this issue Sep 15, 2023
4 tasks
@martincostello martincostello added this to the v8.0.0 milestone Sep 25, 2023
@martincostello martincostello added v8 Issues related to the new version 8 of the Polly library. and removed up-for-grabs labels Sep 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation v8 Issues related to the new version 8 of the Polly library.
Projects
No open projects
Status: Done
Development

Successfully merging a pull request may close this issue.

3 participants