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

Getting Started page has a wrong permalink #78

Open
CanCodes opened this issue Oct 22, 2024 · 3 comments · May be fixed by #79
Open

Getting Started page has a wrong permalink #78

CanCodes opened this issue Oct 22, 2024 · 3 comments · May be fixed by #79
Labels
bug Something isn't working good first issue Good for newcomers

Comments

@CanCodes
Copy link

The getting-started.md file has it's permalink set to docs, resulting in some redirection issues:

<p>To install Effekt and try the examples on your own computer you can follow the <a href="docs/getting-started">installation instructions</a>.</p>

You can immediately experiment with the Effekt language, without [installing](docs/getting-started) it.

Of course, we are happy if you <a href="docs/getting-started">try it out</a> and report your experience with it.</p>

These redirects all fail, resulting in a 404 page. Changing the permalink or the redirects should fix the issue.

@jiribenes
Copy link
Contributor

Thanks for the nice issue, I can easily reproduce this! :)

@jiribenes jiribenes added the bug Something isn't working label Oct 22, 2024
@jiribenes jiribenes added the good first issue Good for newcomers label Nov 6, 2024
@jiribenes
Copy link
Contributor

jiribenes commented Nov 6, 2024

The quick solution here is just to change the links to point to /docs, a more long-term one would be to also set-up a redirect from docs/getting-started to docs so that we don't hurt the poor search engines. :)

As far as I remember, a classic way to do that with Jekyll is putting something like:

{% if page.redirect %}<meta http-equiv="refresh" content="0; url={{ page.redirect }}">{% endif %}

into the header (or making a new layout for pages that should redirect).

If you're tackling this as a part of a "good first issue", feel free to only fix the links and then make a follow-up issue for the redirects. :)

@b-studios
Copy link
Collaborator

For the time being, I just changed the link in the Effekt README.md

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants