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: remove index.html links in top level wg README links #241

Merged
merged 1 commit into from
Dec 16, 2024

Conversation

ramin
Copy link
Contributor

@ramin ramin commented Dec 16, 2024

While digging around the CIPs repo looking to catch up on what i'd missed the last few months, i noticed there was a front README link to the wgs which acted as a landing page, that then linked to each folder for each WG, but those were set as "index.html" and thus would 404 in GitHub.

I've updated the top level /wg/README to link to each WG's folder where GitHub automatically will render the main README.md

eg: https://github.com/ramin/CIPs/blob/ramin/update-wg-links/cips/wgs/README.md

…README.md will be automatically detected and rendered in GitHub UI
Copy link
Collaborator

@rootulp rootulp left a comment

Choose a reason for hiding this comment

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

Thanks Ramin!

I confirmed this works when I run the CIPs site locally and tried the links.

The relative links don't work in the Github preview of the Markdown file but I expect them to work after this PR merges b/c currently they redirect to https://github.com/celestiaorg/CIPs/blob/ramin/update-wg-links/cips/wgs/da and the /blob/ramin/update-wg-links portion won't exist after merging it

@rootulp rootulp merged commit dd1329d into celestiaorg:main Dec 16, 2024
5 checks passed
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.

2 participants