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

Broken documentation links #520

Open
luxmentis opened this issue Dec 12, 2023 · 5 comments
Open

Broken documentation links #520

luxmentis opened this issue Dec 12, 2023 · 5 comments

Comments

@luxmentis
Copy link

The documentation links in README.md lead to a server with a broken https certificate and a "Page not found" message behind that. I've tried

but presumably the problem is the same for all links.

Now I'm reading the code to figure out custom formats, as BaseDestination.format just points to the missing docs (documentation in code would be nice).

@nickx3389
Copy link

+1

@jsimonlane
Copy link
Contributor

@skreutzberger
Copy link
Collaborator

ah damn, right! I totally forgot to migrate them. I guess we should move them to the Github repo's wiki? What do you guys think? What is the best location for now also open-sourced docs?

@laike9m
Copy link

laike9m commented Apr 24, 2024

GitHub Wiki SGTM

@luxmentis
Copy link
Author

What is the best location for now also open-sourced docs?

I'm not really across all the options, but wherever's discoverable for consumers (i.e. anywhere as long as there's a link in the README) and maintainable for you. Presumably the wiki would be suitable.

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

5 participants