Skip to content
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

Closed
wants to merge 1 commit into from
Closed

Documentation Refactor #9196

wants to merge 1 commit into from

Conversation

hogepodge
Copy link
Contributor

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.

Additionally, many of the documents were edited for clarity or reformatted for consistency.

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.
@hogepodge
Copy link
Contributor Author

A preview of the documentation is available at http://mochi.horse:8081

@tqchen
Copy link
Member

tqchen commented Oct 4, 2021

Thanks @hogepodge for pushing this.

  • Just noticed that there are files that are moved and lost history(e.g. For example, device_target_interactions.rst). It would be great to keep all the history (by starting from the original state, run git mv to get the files into the right location, then copy over the changes).
  • There are also format that was due to possible editor auto-format wrapping, these are something that we can do as followups, but we also need to make sure one editor setting do not override another one. One thing to note is that it might be useful to introduce an automatic formater to ensure consistency as a later point.

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

@hogepodge
Copy link
Contributor Author

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
Copy link
Member

@tqchen tqchen Oct 4, 2021

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.

Copy link
Contributor

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?

Copy link
Member

@tqchen tqchen Oct 4, 2021

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

@hogepodge hogepodge closed this Oct 4, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants