Before I address the questions and options individually, I want to return to 
one of the motivating factors for why I feel like the proposed model will be 
effective. Please take the time to review t[his talk about the documentation 
system](https://www.youtube.com/watch?v=t4vKPhjcMZg) or the [site describing 
the method](https://documentation.divio.com) as to why it's an effective 
formalism for thinking about documentation.

Many of the alternatives can actually be fit into this formalism, and to me 
it's useful to work within constraints and create a system that has clear 
expectations and boundaries. At a high level, why am I proposing this method?

* I believe it will make for better docs, and better docs make the project 
better.
* Most people want to make better docs and put a lot of work into it, but lack 
experience and grounding in what makes docs better.
* With a formalism in place, it will actually make it easier to write these 
docs, and teach others in the community to write and contribute to docs.
* Structure and consistency is difficult. Let's reduce the surface area of 
ideas and make the structure and layout consistent.
* Others have thought deeply about this, and just as the contributors to this 
project have thought deeply about deep learning and use TVM to share that 
knowledge and expertise, we should also learn from those who have thought 
deeply about documentation.

TVM has a lot of amazing documentation, capturing and distilling the expertise 
of the community. This is about organization, going from something like this:

![docs1|690x383](upload://cf5QxOmP7i7SSq6VnB1WmPQ5YfU.jpeg) 

to something like this:

![docs2|690x379](upload://jNnEydhiAjk4ebV1BwhqC2DXg64.jpeg)

I'm working right now on taking the feedback so far and refining the proposal 
based on it, and addressing your feedback. But please, if you have a moment 
take some time to review the source materials I've been working from, and that 
I based this proposal on.





---
[Visit Topic](https://discuss.tvm.apache.org/t/updated-docs-pre-rfc/10833/7) to 
respond.

You are receiving this because you enabled mailing list mode.

To unsubscribe from these emails, [click 
here](https://discuss.tvm.apache.org/email/unsubscribe/2e8946ebc4b0004106cdf521434bb72af9dcdb799b509f7087611d59cb97b237).

Reply via email to