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

Fix link #1443

Merged
merged 2 commits into from
Dec 21, 2021
Merged

Fix link #1443

merged 2 commits into from
Dec 21, 2021

Conversation

dr0i
Copy link
Contributor

@dr0i dr0i commented Dec 21, 2021

This PR is directed at the published branch since it just fixes a link in the documentation.

@dr0i
Copy link
Contributor Author

dr0i commented Dec 21, 2021

No clue why this could fail a test-ts-unit.

@dr0i
Copy link
Contributor Author

dr0i commented Dec 21, 2021

I close this issue for the links are properly working when building the site at https://calva.io/debugger/ .

@dr0i dr0i closed this Dec 21, 2021
@PEZ
Copy link
Collaborator

PEZ commented Dec 21, 2021

Hello! Thanks for caring about the documentation!

Did the links work properly in the local/dev site when you had fixed them? If so I think we should merge your fixes, because the current ones do not work on github/when browsing the Calva repo.

The ts-unit tests are a bit flaky. There is a generative test that sometimes produces failing tests. I haven't investigated so I don't yet know if it is the generator that is doing something wrong or that it actually is finding a bug. Anyway, your fix has nothing to do with it.

@PEZ PEZ reopened this Dec 21, 2021
@dr0i
Copy link
Contributor Author

dr0i commented Dec 21, 2021

Did the links work properly in the local/dev site when you had fixed them? If so I think we should merge your fixes, because the current ones do not work on github/when browsing the Calva repo.

Yes, after the fix they work at github, see https://github.com/dr0i/calva/blob/fixLink/docs/site/debugger.md which references https://github.com/dr0i/calva/blob/fixLink/docs/site/jack-in-guide.md and https://github.com/dr0i/calva/blob/fixLink/docs/site/getting-started.md.

@PEZ
Copy link
Collaborator

PEZ commented Dec 21, 2021

Sorry for being unclear. I did check that your links worked on github and that the current links don't. That's why I reopned. 😄

However, right now I can't remember if that also means it works on the docs site. The way to test it is to build the docs locally.

@dr0i
Copy link
Contributor Author

dr0i commented Dec 21, 2021

Makes sense. Sorry for being a bit dumb :) With your hint, I did mkdocs serve in the fixLink branch and visited http://127.0.0.1:8000/debugger/ - and the links are there good, too ! So the mkdocs seem to strip the md suffix of relative links in the markdown files. So indeed this PR should work for both: github and the generated docs.

@PEZ
Copy link
Collaborator

PEZ commented Dec 21, 2021

That's awesome. Thanks again!

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

Successfully merging this pull request may close these issues.

2 participants