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

Update README #1035

Merged
merged 2 commits into from
Nov 12, 2021
Merged

Update README #1035

merged 2 commits into from
Nov 12, 2021

Conversation

abejgonzalez
Copy link
Contributor

Related issue:

Type of change: bug fix + other enhancement

Impact: other

Release Notes
Fixes issue where README shown would default to the .github/README.md instead of the top-level README.md. Additionally adds a new section at the top of the README.md for quick links. My reasoning for adding this is that it makes it extremely easy to find the link to the mailing list (called forum here) for people who don't care to read down the README.md. This aligns with #1029 where I pointed to the mailing list more.

@abejgonzalez abejgonzalez self-assigned this Nov 5, 2021
@jerryz123
Copy link
Contributor

What is the README bug? Having multiple READMEs should be supported.

@abejgonzalez
Copy link
Contributor Author

What is the README bug? Having multiple READMEs should be supported.

If there is a README in the .github area, it will show that one by default instead of the one in the top-level of the repo.

@jerryz123
Copy link
Contributor

Its useful to have README.md in the subdirectories, as it shows up when you browse there in Github, I think this may be a one-off rendering bug, rather than a repo bug.

Here's a screenshot of what I mean. If you rename it this will not longer show up.

image

@abejgonzalez
Copy link
Contributor Author

Its useful to have README.md in the subdirectories, as it shows up when you browse there in Github, I think this may be a one-off rendering bug, rather than a repo bug.

Here's a screenshot of what I mean. If you rename it this will not longer show up.

image

I agree, but I think this is an issue with the priority of the .github vs the root directory README.md file... I would look at the two PR commits to see the difference.

@abejgonzalez abejgonzalez merged commit 3601516 into dev Nov 12, 2021
@abejgonzalez abejgonzalez deleted the readme-rework branch September 19, 2022 20:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants