docs: broken internal links

[barakplasma]

Description

there are some broken internal links (404 page) within this file.
I correctly as many as I could within 5 min. There may be more broken links.

I didn't open an issue for this.

Type of Change

• Bug fix (non-breaking change which fixes an issue)

How Has This Been Tested?

I used the preview feature in github.

Checklist: (Feel free to delete this section upon completion)

• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• I have updated type definitions in index.d.ts for any breaking API changes
• My code follows the style guidelines of this project (I have run yarn format)
• I have added tests that prove my fix is effective or that my feature works
• New and existing unit tests pass locally with my changes (I have run yarn test)
• My changes generate no new warnings
• Any dependent changes have been merged and published in downstream modules

[kale-stew]

Hi @barakplasma - thank you for taking time to try to fix these.

We handle our links a little differently in the docs. As they are compiled and hosted on our main website, formidable.com, we need to keep the links relevant to the docs themselves, not the Github preview, so adding /content/ to the slug will break the hosted link (although it will fix the Github preview).

I realize this is a little confusing, but if you check out the hosted tutorial (at https://formidable.com/open-source/spectacle/docs/tutorial/), you'll find those links do take you to the correct location. Do you think it would be helpful to add a blurb about this to our Contributing document? Or maybe a comment to the markdown file in Github itself?

[barakplasma]

I think it's fine as is in that case. Sorry for wasting your time.

Thanks for working on spectacle, used it today for a presentation.

[kale-stew]

You didn't waste anyone's time, @barakplasma! In fact, you surfaced an ongoing issue that we definitely need to address - the disparity between our links in the docs make one version of them virtually unusable, and this is an issue.

We've actually opened up an issue to track this thanks to you - check out 878 if you're curious. Thanks again for your contribution!