Documentation exclusively for project developers lives in
developers/, while the source pages and assets for IREE's
user-focused website live in website/.
Developer documentation should use GitHub-flavored markdown (see this guide), while the website uses MkDocs, with the Material for MkDocs theme.
A high bar should be set for pages published to the website:
- Page structure should be consistent across sections
- Content should be kept up to date regularly
- Instructions should be portable across environments (e.g. don't overspecialize on a specific Linux distribution or a particular version of Visual Studio on Windows)
Developer documentation can compromise on each of these points. Pages may also be promoted to website/ after some refinement.