Skip to content

Formalize TVM Documentation Organization - #27

Merged
tqchen merged 15 commits into
apache:mainfrom
hogepodge:docs-refactor
Sep 14, 2021
Merged

tqchen merged 15 commits into
apache:mainfrom
hogepodge:docs-refactor

Conversation

@hogepodge

Copy link
Copy Markdown
Contributor

No description provided.

@hogepodge hogepodge changed the title RFC for TVM Documentation Refactoring Formalize TVM Documentation Organization Sep 1, 2021

@areusch areusch left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@hogepodge thanks for sending this! it'll be a welcome refactor to our documentation. I just had a couple small clarifications I wanted to request--I think the spirit of everything is captured well here but I want to make sure we're as clear as possible in the descriptions

Comment thread rfcs/0027-formalize-documentation-organization.md Outdated
Comment thread rfcs/0027-formalize-documentation-organization.md Outdated
Comment thread rfcs/0027-formalize-documentation-organization.md Outdated
Comment thread rfcs/0027-formalize-documentation-organization.md Outdated
@apache apache deleted a comment from tvm-archiver Sep 1, 2021
@apache apache deleted a comment from tvm-archiver Sep 1, 2021

@tkonolige tkonolige left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think these changes will be great for all users. One question: is this RFC going to be turned into a document on where to put tutorials/how-tos/reference? I think that would be useful.

Comment thread rfcs/0027-formalize-documentation-organization.md Outdated
Comment thread rfcs/0027-formalize-documentation-organization.md Outdated
Comment thread rfcs/0027-formalize-documentation-organization.md Outdated
Comment thread rfcs/0027-formalize-documentation-organization.md
Comment thread rfcs/0027-formalize-documentation-organization.md Outdated
Comment thread rfcs/0027-formalize-documentation-organization.md Outdated
Comment thread rfcs/0027-formalize-documentation-organization.md Outdated
Comment thread rfcs/0027-formalize-documentation-organization.md Outdated
Comment thread rfcs/0027-formalize-documentation-organization.md Outdated
Comment thread rfcs/0027-formalize-documentation-organization.md
@tqchen tqchen added the status: need review RFC needs review label Sep 2, 2021
Comment thread rfcs/0027-formalize-documentation-organization.md Outdated
hogepodge and others added 8 commits September 7, 2021 17:36
Co-authored-by: Tristan Konolige <tristan.konolige@gmail.com>
Co-authored-by: Tristan Konolige <tristan.konolige@gmail.com>
Co-authored-by: Tristan Konolige <tristan.konolige@gmail.com>
Co-authored-by: Tristan Konolige <tristan.konolige@gmail.com>
Co-authored-by: Tristan Konolige <tristan.konolige@gmail.com>
Co-authored-by: Tristan Konolige <tristan.konolige@gmail.com>
Co-authored-by: Tristan Konolige <tristan.konolige@gmail.com>
@hogepodge

Copy link
Copy Markdown
Contributor Author

Looking for some more reviews to move this forward: @tqchen @masahi @comaniac @icemelon @leandron

@tkonolige tkonolige left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In general everything looks pretty good. Thanks @hogepodge! I've left a couple suggestions on grammar and clarity.

Comment thread rfcs/0027-formalize-documentation-organization.md Outdated
Comment thread rfcs/0027-formalize-documentation-organization.md Outdated
Comment thread rfcs/0027-formalize-documentation-organization.md Outdated
Comment thread rfcs/0027-formalize-documentation-organization.md Outdated
Comment thread rfcs/0027-formalize-documentation-organization.md Outdated
Comment thread rfcs/0027-formalize-documentation-organization.md Outdated
Comment thread rfcs/0027-formalize-documentation-organization.md Outdated
Comment thread rfcs/0027-formalize-documentation-organization.md Outdated
Comment thread rfcs/0027-formalize-documentation-organization.md Outdated
Comment thread rfcs/0027-formalize-documentation-organization.md Outdated

@tqchen tqchen left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM from my side

@comaniac comaniac left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. One point that I think is worthwhile to bring up is by this PR: apache/tvm#8893. Maybe we could also consider future extensions like that, and make sure we have a proper place for it (Relay pass examples in this case).

* Topic Guide
* Developer Guide
* TVM Architecture Guide
* API Reference (reference)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

minor note: we have language reference which served as a comprehensive reference to the language specification. see https://tvm.apache.org/docs/langref/index.html, would be great to clarify where do they fit

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It could go either way, in the Architecture Guide or in the Reference. Since it started as a reference document, and language references are much more status, I expanded the Reference section to include API and Language. Let me know what you think.

@hogepodge

Copy link
Copy Markdown
Contributor Author

Any further changes requested? I'd like to start driving this work forward.

@tqchen

tqchen commented Sep 14, 2021

Copy link
Copy Markdown
Member

cc @areusch would be great if we can followup, we will wait for 24hours and then merge it in if there is no further comment

@areusch areusch left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks @hogepodge !

@tqchen
tqchen merged commit d370803 into apache:main Sep 14, 2021
@tqchen tqchen added status: accepted RFC is accepted and removed status: need review RFC needs review labels Sep 14, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

status: accepted RFC is accepted

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants