-
Notifications
You must be signed in to change notification settings - Fork 3.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Documentation Refactor #9196
Documentation Refactor #9196
Conversation
This patch is the documentation refactor described in RFC 0027: RFC: https://github.com/apache/tvm-rfcs/blob/main/rfcs/0027-formalize-documentation-organization.md Tracking Issue: #8987 At a high level, the reorganization consisted of: * Removing old README files in tutorials * User how-tos moved from tutorials to gallery * Getting Started Section * Install * Contributor Guide * Expansion of documentation guide * Include addition of a new install from package (tlcpack) section * Developer Guide * Tutorial * How Tos * galleries * errors, faqs, profiling * merging of gallery and how to deploy and integrate sections * Architecture Guide * Design and Architecture * Reference * Language Reference * API * New publications section * Topic Guide * VTA * MicroTVM As a complete documentation refactor, it wasn't feasible to build this patch incrementally for in-place review.
A preview of the documentation is available at http://mochi.horse:8081 |
Thanks @hogepodge for pushing this.
One idea is we start with a PR that only contains git mv and minimum set of changes to get the index right. Then we send into text polishment in followup smaller PRs |
That will be a significant lift, but I can restart the patch if it's necessary. |
@@ -0,0 +1,96 @@ | |||
.. Licensed to the Apache Software Foundation (ASF) under one |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is it possible to leave the folder sections of get_started as is for now
- docs/contribute
- docs/install
The main reason are:
- These are links we commonly link from other places and change them will result in stale links
- We can keep essentially the same navigation structure.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
i'm not sure we should carve out exceptions just due to legacy. what about adding a redirect?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, a redirect also works. BTW. if we look at tutorial and how_to, they are also top-level(so that the URL is shorter), so in some sense we may or maynot consider this as exception. The navigation structure remains the same
This patch is the documentation refactor described in RFC 0027:
RFC: https://github.com/apache/tvm-rfcs/blob/main/rfcs/0027-formalize-documentation-organization.md
Tracking Issue: #8987
At a high level, the reorganization consisted of:
As a complete documentation refactor, it wasn't feasible to build this
patch incrementally for in-place review.
Additionally, many of the documents were edited for clarity or reformatted for consistency.