This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# 2019 Google Season of Docs Project Report - LLVM Compiler Infrastructure | |
My Google Season of Docs project for the LLVM Compiler Infrastructure involved restructuring the documentation site and updating the Sphinx style guide for new contributors. For a list of commits associated with my project, see https://github.com/llvm/llvm-project/commits?author=drichards-87. | |
Restructuring the LLVM documentation site was my primary focus during the doc development phase of the program. The old site consisted of a single page on which all articles were listed. The steps I took to accomplish my goal are as follows: | |
1. Inventoried the existing articles on the documentation site. | |
2. Reviewed each article to identify common patterns, subjects, etc. | |
3. Categorized the articles based on subject and topic type (e.g., overview, task, reference). | |
4. Added new pages for each high-level category (Getting Started/Tutorials, User Guides, Reference, Community). |