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 github links #2715

Merged
merged 1 commit into from
Nov 21, 2024
Merged

fix github links #2715

merged 1 commit into from
Nov 21, 2024

Conversation

imolorhe
Copy link
Collaborator

@imolorhe imolorhe commented Nov 21, 2024

Fixes

Closes #2714

Checks

  • Ran yarn test-build
  • Updated relevant documentations
  • Updated matching config options in altair-static

Changes proposed in this pull request:

Summary by Sourcery

Bug Fixes:

  • Correct GitHub links in the documentation to point to the correct paths.

Copy link

sourcery-ai bot commented Nov 21, 2024

Reviewer's Guide by Sourcery

This PR updates GitHub repository links to fix incorrect branch references and outdated documentation paths. The changes primarily focus on updating the documentation configuration and contributing guide to reflect the correct repository structure.

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

File-Level Changes

Change Details Files
Update GitHub repository links and branch references
  • Change edit link branch from 'main' to 'master' in VitePress configuration
  • Update documentation repository path reference in contributing guide
packages/altair-docs/.vitepress/config.mts
packages/altair-docs/docs/contributing.md

Assessment against linked issues

Issue Objective Addressed Explanation
#2714 Fix broken documentation link that points to non-existent /site/src/docs directory

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.

Hey @imolorhe - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@imolorhe imolorhe added this pull request to the merge queue Nov 21, 2024
Merged via the queue into master with commit 27560dc Nov 21, 2024
13 checks passed
@imolorhe imolorhe deleted the imolorhe/fix-gh-links branch November 21, 2024 10:32
Copy link

Visit the preview URL for this PR (updated for commit 59f3566):

https://altair-gql--pr2715-imolorhe-fix-gh-link-8yx62qfo.web.app

(expires Thu, 28 Nov 2024 10:37:28 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

Sign: 02d6323d75a99e532a38922862e269d63351a6cf

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.

[BUG] Contributing docs link to non-existent part of the repository
1 participant