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

Fixing the problem of Dead link in documentation. #543

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

alok1304
Copy link

@alok1304 alok1304 commented Nov 5, 2024

#540 fix. Now I fix the problem of Dead link in documentation.
Screenshot 2024-11-05 115146

Copy link
Member

@JonoYang JonoYang left a comment

Choose a reason for hiding this comment

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

@alok1304 Thanks for the PR, I left some comments.

.. note::
This tutorial assumes that you have a working installation of PurlDB. If you
don't, please refer to the `installation
<../purldb/overview.html#installation>`_ page.

<https://aboutcode.readthedocs.io/projects/PURLdb/en/latest/how-to-guides/installation.html>`_
Copy link
Member

Choose a reason for hiding this comment

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

This should not be an absolute link to the readthedocs page. We want to use cross-references (https://www.sphinx-doc.org/en/master/usage/referencing.html)

Copy link
Member

Choose a reason for hiding this comment

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

This file should be removed.

Copy link
Author

@alok1304 alok1304 left a comment

Choose a reason for hiding this comment

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

Finally i do it by using cross-reference and also I removed this file package-lock.json.

Also, I have attached a video of that.

Code.Matching.PurlDB.documentation.-.Google.Chrome.2024-11-06.14-28-57.mp4

alok1304 and others added 3 commits November 6, 2024 15:28
Signed-off-by: Alok Kumar <[email protected]>
Signed-off-by: Alok Kumar <[email protected]>
Signed-off-by: Alok Kumar <[email protected]>
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