search

ambientsprotocol / whitepaper

📄 The Ambients protocol white paper
Creative Commons Attribution Share Alike 4.0 International
46 stars 4 forks source link

Links broken when reading md on github #4

Open JoshOrndorff opened 5 years ago

JoshOrndorff commented 5 years ago

Many links like the ones that say "later chapters" in https://github.com/ambientsprotocol/whitepaper/blob/master/04-protocol-overview.md#ambients-protocol-summary work correctly in the pdf, but not when reading markdown online.

The problem is that the heading that are being linked to are assumed to exist in the same file, but in fact they are in separate files.

Maybe this is intended/accepted behaviour in which case you can just close this. Just wanted to point it out as it confused me while I was reading.

haadcode commented 5 years ago

Thanks for pointing this out @JoshOrndorff! Totally valid and it'd be good to fix them 👍

The reason they're broken is, when reading individual md files, that we assume they all get put together to one document, but obviously this doesn't work across files. Perhaps a good way to fix all of them would be to fix individual md files to link to the absolute url and then in the build process (the pdf generator tool), replace the absolute url with just the internal link.

If anyone's up for helping with this, would be happy of a PR that does it 🙏