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

The docs links show 404 #204

Open
Idimmusix opened this issue Dec 8, 2022 · 6 comments
Open

The docs links show 404 #204

Idimmusix opened this issue Dec 8, 2022 · 6 comments

Comments

@Idimmusix
Copy link

The links to the github pages containing the docs show a 404.

@rustam-python
Copy link

rustam-python commented Jan 17, 2023

+1, please fix it

@djordan-ri
Copy link

+1 Please fix.

@trallnag
Copy link
Owner

trallnag commented Jul 21, 2023

The page does not exist anymore. What are you struggeling with? Also I have removed the links now.

trallnag added a commit that referenced this issue Jul 21, 2023
Pointed out in GitHub issue #204
@djordan-ri
Copy link

@trallnag I don't have a particular issue, but it's frustrating when you're trying to develop, docs are linked, and then they're dead. Are I see in your commit that you've removed the links now. Are there any plans to re-document, or provide other usage examples :) ?

@trallnag
Copy link
Owner

@djordan-ri, nope. The formerly existing documation was merely automatically generated from the source code and comments. And some point I removed this because one can just look directly at the code in GitHub.

I've collected some examples here: https://github.com/trallnag/prometheus-fastapi-instrumentator/tree/master/devel/examples

@djordan-ri
Copy link

Right. Understood. In that case, it might resolve the issue to link those examples in the top-level README. I hadn't found those exemplars, and I think most would be surprised to find them under devel/

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