Hi,

I like the fact that we have a consistent documentation section in our
site. I also like the README.md, it's very much 'in-your-face' for
developers and also for users browsing via Github.

I was thinking for some time whether we can unify them by storing the
canonical information in Github as README.md files and then copying the
files to the Sling site after each release.

This can of course be scripted and we can apply some minimal pre-
processing if needed when committed. One issue that I see is that ASF-
specific markup, like the ref generation  ( {{ refs.resources.path }} )
 will not make sense when viewed out of context.

Thoughts?

Robert

Reply via email to