Skip to content

Fix links in documentation #1134

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

Merged
merged 8 commits into from
Jun 28, 2025
Merged

Fix links in documentation #1134

merged 8 commits into from
Jun 28, 2025

Conversation

yangdanny97
Copy link
Contributor

@yangdanny97 yangdanny97 commented Jun 27, 2025

Summary of changes:

  • fix anchor names/capitalization in links (they are always kebab case, lowercased)
  • change relative references to point to .ipynb (.html relative references do not generate correctly, it seems)
  • move Contributing.md contents into Contributing.ipynb. If we {include} the former into the latter, the documentation links will not work due to the extra ./docs/ prefix. I don't think there's an easy way to write links that will work for both, so I just moved it.

References

closes #1132

Chores

  • linted
  • tested (python scripts/docs.py and clicked around the built docs)
  • documented
  • changelog entry

Copy link

Binder 👈 Launch a binder notebook on branch yangdanny97/jupyterlab-lsp/main

@yangdanny97 yangdanny97 marked this pull request as draft June 28, 2025 00:11
@yangdanny97 yangdanny97 marked this pull request as ready for review June 28, 2025 03:50
@yangdanny97
Copy link
Contributor Author

CI seems kind of noisy, not sure what to make of it

Copy link
Member

@krassowski krassowski left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

@krassowski
Copy link
Member

Yes, we need to fix some tests or mark them as XFail for now.

@krassowski krassowski merged commit 15c5c70 into jupyter-lsp:main Jun 28, 2025
12 of 21 checks passed
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.

Links in docs do not work
2 participants