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 broken links in documentation by updating to absolute URLs #1304

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

codeautopilot[bot]
Copy link

@codeautopilot codeautopilot bot commented Dec 8, 2024

Resolves #1277

This pull request updates the relative links in the docs/README.md file to absolute URLs to ensure they work correctly on the Read the Docs site.

Summary by Sourcery

Documentation:

  • Update relative links to absolute URLs in the documentation to ensure they work correctly on the Read the Docs site.

Copy link

sourcery-ai bot commented Dec 8, 2024

Reviewer's Guide by Sourcery

The pull request updates all documentation links in the README.md file from relative paths to absolute URLs pointing to the Read the Docs site. This change ensures that links work correctly when viewed on Read the Docs, improving documentation accessibility.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Convert documentation links from relative paths to absolute URLs
  • Update installation guide link to Read the Docs URL
  • Convert directory structure reference link
  • Update smallbaselineApp.cfg configuration file link
  • Change demo dataset and example links
  • Update links to mintpy objects and utils documentation
  • Convert contributing guide link
  • Update template file and references links
docs/README.md

Assessment against linked issues

Issue Objective Addressed Explanation
#1277 Fix broken documentation links that don't work on readthedocs.io by replacing relative URLs with absolute URLs

Possibly linked issues


Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

We have skipped reviewing this pull request. It seems to have been created by a bot (hey, codeautopilot[bot]!). We assume it knows what it's doing!

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.

Broken links in website docs
0 participants