elevenlabs / elevenlabs-docs

Documentation for elevenlabs.io/docs
https://elevenlabs.io/docs
67 stars 291 forks source link

fix: all broken links #458

Closed louisjoecodes closed 3 weeks ago

louisjoecodes commented 4 weeks ago
mintlify broken-links
-> No broken links found.

Note: Our entire documentation site is hosted under the /docs path. Will need to see that all links checked using mintlify dev and the link check command reflect this base path correctly.

louisjoecodes commented 4 weeks ago

Hey @J-ElevenLabs just did a quick check of our links/images.

To satisfy mintlify broken-links I had to remove /docs from some of the URLs

i.e.

href="/docs/voices/voice-lab/voice-design" to ref="/voices/voice-lab/voice-design

Have you encountered this issue before? It seems that most of our URLs don’t include /docs.

lacop11 commented 3 weeks ago

Isn't the problem that branch preview is served from root (uniquedomain.mintlify.app/...) but in prod our docs are served from elevenlabs.io/docs/...?

So links like /foo will work on preview but not in prod, and in prod we have to do /docs/foo.

Which is slightly annoying. We could have docs.elevenlabs.io/..., in fact that redirects to elevenlabs.io/docs/... and we could switch the redirect around. Not sure why it was done this way and if we want to change it or not.

J-ElevenLabs commented 3 weeks ago

Do you still need a review from me here? I wrote the long reply, but I forgot to send it a couple of days ago.

Basically, what I said is that the way the links are written depends on who authored the guide. I tried to make the links dynamic, which means I don't use the full link, and I don't use docs/ since that is the root as stated above. However, previously, we had the documentation as docs.elevenlabs.io, which I have always preferred much more. If we want to, I would like to change it back to that. We could perhaps even consider using both docs. and api., which I have always liked just like we have help.elevenlabs.io.

Do you want me to review and merge this, or is there some discussion to be had?