search

napari / docs

Documentation for napari (other than API docs)
BSD 3-Clause "New" or "Revised" License
11 stars 36 forks source link

Fix broken links and references #338

Closed melissawm closed 8 months ago

melissawm commented 8 months ago

References and relevant issues

Closes #331

Description

Fixes a few references that were creating "duplicate target" warnings when building the docs. Also fixes links in team page and a few other pages.

A few references are renamed, because they trigger duplicate reference warnings. For example, if a file is called "benchmarks.md" and its reference targe is (benchmarks)=, the link would have to be marked as either the ref role or the doc role. To make it easier to link, I've changed the reference name to napari-benchmarks. There's a couple other instances of the same issue.

This is meant to guarantee the links will still be valid even after reorganizations such as the recent contributing docs reorg.

psobolewskiPhD commented 8 months ago

Oh! that makes sense! Should we also fix usage in usage.md? It doesn't look like it's used as a link, but it's the same issue if we ever do link to it?

Edit: And am I understanding correctly that tutorials works (on that usage.md) because it will point to tutorials/index.md?

melissawm commented 8 months ago

Oh! that makes sense! Should we also fix usage in usage.md? It doesn't look like it's used as a link, but it's the same issue if we ever do link to it?

Edit: And am I understanding correctly that tutorials works (on that usage.md) because it will point to tutorials/index.md?

I'd actually wait for that problem to happen, honestly 🤷🏻‍♀️ I'm not sure we'll ever need to link to that page.

And for the tutorials, I'm actually not sure, but your hypothesis does make sense 😄