docs: add docs for MultiDocRef, improve error handling

[mortenpi]

I am not sure we can fix https://github.com/JuliaComputing/MultiDocumenter.jl/issues/74#issuecomment-1798856826, but this should at least yield a better error message, and also generally document the arguments of MultiDocRef.