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

Docs: Tweak some links #40704

Closed
wants to merge 3 commits into from
Closed

Conversation

louismaximepiton
Copy link
Member

@louismaximepiton louismaximepiton commented Aug 7, 2024

Description

Changed some links to blob from current main.

Motivation & Context

Better convey information to people trying to contribute.

Type of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Refactoring (non-breaking change)
  • Breaking change (fix or feature that would change existing functionality)

Checklist

  • I have read the contributing guidelines
  • My code follows the code style of the project (using npm run lint)
  • My change introduces changes to the documentation
  • I have updated the documentation accordingly
  • (N/A) I have added tests to cover my changes
  • All new and existing tests passed

Live previews

Related issues

NA

Copy link
Member

@julien-deramond julien-deramond left a comment

Choose a reason for hiding this comment

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

I was about to approve the PR, but I'm starting to have mixed feelings about it.
I was about to approve the PR, but I'm starting to have mixed feelings about it. On one hand, I like the approach, especially for the contributing guidelines, as it will always link to the latest version, reflecting our current thoughts on how folks should contribute. On the other hand, if the file is moved, all the links in previous versions would need to be updated in gh-pages.

For instance, the CONTRIBUTING.md file could be moved to the root directory or the docs directory, and the package.json could be replaced by another method of managing our repository.

I'll let other core team members share their thoughts, as I still don't have a strong opinion on it.

However, if this PR is not accepted, we should keep the modifications you've made with the backticks ;)

@XhmikosR
Copy link
Member

Sorry, don't like that. I'd rather use the variables.

@XhmikosR XhmikosR closed this Aug 13, 2024
@XhmikosR XhmikosR deleted the main-lmp-tweak-some-links branch August 13, 2024 12:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants