Thanks, @hogepodge. It's a good opportunity for us to enhance TVM documentation 
and tutorials together. I want to share some of my thoughts on it.

## A Separated Developer Documentation
Users(who will use TVM as a tool to compile models on supported models and 
backends and won't change much of the implementations) want to start quick and 
finally make full use of TVM API, so they need:

1. Simple, meaningful, and runnable (important) demos and tutorials for getting 
started.
2. Detailed API document to use all functions.

While developers(who will try to support new models or integrate TVM on new 
backends) need to know the whole architecture and design philosophy of each 
part, these things may be exactly what they want:

1. A whole picture of TVM architecture.
2. Design philosophy and terminology of each part.
3. A few develop tutorials (e.g., adding Relay/TIR passes, adding TensorIR 
schedule primitives) if possible.

##  Nest Organization for Developer but Flat One for the Other
Nested documents are not friendly to those new users, who want to get started 
without knowing too much details quickly. On the other hand, developer docs may 
be more than user guilds. It would be great to use sub-folders to organize them.

## List of Supported Ops
I think it is beneficial information for both users and developers. Users may 
know that why my model cannot be compiled while Developers can help to add new 
ops. One more step, it may encourage users become developers and enlarge the 
community.

## One Proposal
- Get started
  - About
  - Installation
  - Demos
- Tutorials
- Supported Ops (and models)
- Python API
- Developer Documentation
  - Architecture review
  - Frontend
  - Relay
    - Overview and Philosophy
    - Terminology and Data Structure 
    - How to (add new op, add new pass)
  - TE
  - TensorIR
  - More ...

## Other minor points
1. A good search engine is necessary. The current one is good but can be better 
if possible.
2. The gallery is a little bit ugly without cover images.

That's some comments and one proposal from me. Please feel free to suggest.





---
[Visit Topic](https://discuss.tvm.apache.org/t/updated-docs-pre-rfc/10833/5) 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/d57510bf5e54318ddb1d141a1390575adeaf927401907830d85aa797a816ed37).

Reply via email to