search

zcash / zcash-docs

Translations of Zcash documentation
Other
29 stars 20 forks source link

Investigate auto-mirroring markdown pages #32

Closed lindanlee closed 4 years ago

lindanlee commented 4 years ago

This would then get rid of the need to link out to github page readmes and keep more people and content inside the docs portal.

If this is not possible, or requires a lot of work, we can drop it.

lindanlee commented 4 years ago

Charlie says: Keeping things in sync is a pain. And, as Taylor pointed out, there will be reasons for docs outside the repo to be different, like notes about version X that were made after the tagging of version X. I’d have the README in the docs point to the main documentation site where people can find out more.

lindanlee commented 4 years ago

Taylor says: Docs in github repos alongside the code are tied to the version of the software, which could be good or bad. It could be good because if you clone the repo and check out a tag for an old version, you don't get distracted by docs for the new version (which might be incorrect for the old version, e.g. build instructions). It could be bad because you can't ever update the docs that come with an old version, e.g. to put warnings about security vulnerabilities or advertise features in newer versions.