Skip to content

Broken images in README.md #94

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

Closed
fabriziofiorucci opened this issue May 31, 2024 · 4 comments
Closed

Broken images in README.md #94

fabriziofiorucci opened this issue May 31, 2024 · 4 comments

Comments

@lcrilly
Copy link
Contributor

lcrilly commented May 31, 2024

The offending lines are
https://github.com/nginxinc/nginx-openid-connect/blob/main/README.md?plain=1#L9
https://github.com/nginxinc/nginx-openid-connect/blob/main/README.md?plain=1#L22

I have a mermaid diagrams for the images - it might be a better way forwards. Happy to submit a PR from my fork
See https://github.com/lcrilly/nginx-openid-connect/blob/master/README.md

@route443
Copy link
Contributor

Hi @lcrilly ,

I've been aware of your fork for some time and was actually curious why this hadn't been suggested earlier! :)
The idea of replacing the current bin images with mermaid diagrams sounds excellent. It wold make maintain the docs easier and ensure that the diagrams are always up-to-date with the source code.
Please feel free to submit a PR from your fork!

@lcrilly
Copy link
Contributor

lcrilly commented May 31, 2024

Ha! I just did it to learn Mermaid and then kinda forgot about it. Will submit a PR soon.

@lcrilly
Copy link
Contributor

lcrilly commented Jun 2, 2024

Submitted #95

@route443 route443 closed this as completed Jun 6, 2024
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

3 participants