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: Use relative link to other README files #450

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

Conversation

hasecilu
Copy link

@hasecilu hasecilu commented Sep 27, 2024

Current README on develop gives 404 error when clicking Spanish link.

`master` branch was hardcoded despite working on `develop` branch
@JYC333
Copy link

JYC333 commented Sep 28, 2024

I think that because we are pointing to master branch README, and now Spanish README doesn't merge into master yet. Using relative link might be a better way.

And I also think put the README files in repo root is not so clean, maybe move other languages' README files into .github? See some repos doing like this. What's your thought @eliandoran?

@perfectra1n
Copy link

perfectra1n commented Sep 30, 2024

I feel like .github/ is reserved explicitly for GitHub-related functionality (such as GitHub Actions). Since docs/ is already being used, perhaps a folder such as readme/ might be a better choice? I'm not completely against .github/ however.

Yes, doing the relative links is a great option, thanks for bringing that up. The only downside is for sites like DockerHub that ask for a README, I'll have to remember to change from relative links to absolute...

@perfectra1n
Copy link

Another example of something similar - Immich uses a folder called readme_i18n/ to hold the README.md files for other languages.

@hasecilu
Copy link
Author

hasecilu commented Oct 3, 2024

Another example of something similar - Immich uses a folder called readme_i18n/ to hold the README.md files for other languages.

lgtm

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.

3 participants