almindor / mipidsi

MIPI Display Serial Interface unified driver
MIT License
117 stars 46 forks source link

Link to TROUBLESHOOTING.md in the docs is broken #76

Closed rfuest closed 7 months ago

rfuest commented 11 months ago

The link to TROUBLESHOOTING.md from lib.rs broken, because of the split into the mipidsi and mipidsi-async directories. We could either move the docs directory in the root of the repo or change the links to point to the new location. Moving the docs directory into the root would have the advantage that all already released versions of the mipidsi docs would be fixed. In the future we might want to consider to update the links to point to a specific tag/release to be resilient against changes in the repo layout.

rfuest commented 8 months ago

Instead of fixing the link we could also move the troubleshooting document into the crate docs.