updated formatting for README.md and conventions.qmd to match the linter

harvard-edge · Nov 21, 2023 · dcf8c2e · dcf8c2e
1 parent 7d39533
commit dcf8c2e
Show file tree

Hide file tree

Showing 2 changed files with 56 additions and 26 deletions.
diff --git a/README.md b/README.md
@@ -4,15 +4,17 @@
 
 Welcome to the collaborative book repository for students of CS249r: Tiny
 Machine Learning at Harvard! This repository contains the source files
-of chapters and sections written by your peers. We're excited to see your contributions!
+of chapters and sections written by your peers. We're excited to see your
+contributions!
 
 ## Contributing
 
 To contribute to the repository using pull requests, follow these steps:
 
 1. **Fork the Repository**:
 
-    - Navigate to the repository's GitHub page and click the 'Fork' button at the top-right corner.
+    - Navigate to the repository's GitHub page and click the 'Fork' button at
+      the top-right corner.
 
 2. **Clone Your Forked Repository**:
 
@@ -38,7 +40,8 @@ To contribute to the repository using pull requests, follow these steps:
     git checkout -b name-of-your-new-branch
     ```
 
-6. **Make your edits** for your chapter or section in [Markdown](https://quarto.org/docs/authoring/markdown-basics.html).
+6. **Make your edits** for your chapter or section
+   in [Markdown](https://quarto.org/docs/authoring/markdown-basics.html).
 
 7. **Commit Changes to Your Branch**:
 
@@ -53,12 +56,15 @@ To contribute to the repository using pull requests, follow these steps:
     git push origin name-of-your-new-branch
     ```
 
-9. Navigate to your fork on GitHub and click the 'New pull request' button. Ensure you're comparing your branch from
-   your fork to the `main` branch of the original `harvard-edge/cs249r_book` repository.
+9. Navigate to your fork on GitHub and click the 'New pull request' button.
+   Ensure you're comparing your branch from
+   your fork to the `main` branch of the original `harvard-edge/cs249r_book`
+   repository.
 
 10. Submit the pull request with a descriptive message.
 
-The instructors will assess your pull request and provide feedback. Once it's approved, your contribution will be
+The instructors will assess your pull request and provide feedback. Once it's
+approved, your contribution will be
 integrated into the `main` branch, and the book's website will be updated.
 
 For a more detailed guide on the CS249r documentation process and peer review,
@@ -68,7 +74,8 @@ check [here](https://docs.google.com/document/d/1izDoWwFLnV8XK2FYCl23_9KYL_7EQ5O
 
 ## Website
 
-The book's website is automatically constructed from the `gh-pages` branch. Once reviewed, changes to `main` are merged
+The book's website is automatically constructed from the `gh-pages` branch. Once
+reviewed, changes to `main` are merged
 into `gh-pages`.
 
 You can view the book's website
@@ -78,7 +85,9 @@ at: [https://harvard-edge.github.io/cs249r_book/](https://harvard-edge.github.io
 
 ## Local Rendering
 
-You need to have `quarto` installed for local rendering of the book. Please follow the [Quarto installation instructions here](https://quarto.org/docs/download/).
+You need to have `quarto` installed for local rendering of the book. Please
+follow
+the [Quarto installation instructions here](https://quarto.org/docs/download/).
 
 Once that's done, the following command can be
 used to produce the HTML pages:
@@ -148,5 +157,6 @@ quarto render
 
 <!-- ALL-CONTRIBUTORS-LIST:END -->
 
-This project follows the [all-contributors](https://allcontributors.org) specification. Contributions of any kind are
+This project follows the [all-contributors](https://allcontributors.org)
+specification. Contributions of any kind are
 welcome!
diff --git a/conventions.md b/conventions.md
@@ -4,45 +4,65 @@ Please follow these conventions as you contribute to this online book:
 
 1. **Clear Structure and Organization**:
 
-    - **Chapter Outlines**: Begin each chapter with an outline that provides an overview of the topics covered.
-    - **Sequential Numbering**: Utilize sequential numbering for chapters, sections, and subsections to facilitate easy reference.
+    - **Chapter Outlines**: Begin each chapter with an outline that provides an
+      overview of the topics covered.
+    - **Sequential Numbering**: Utilize sequential numbering for chapters,
+      sections, and subsections to facilitate easy reference.
 
 2. **Accessible Language**:
 
     - **Glossary**: Include a glossary that defines technical terms and jargon.
-    - **Consistent Terminology**: Maintain consistent use of terminology throughout the book to avoid confusion.
+    - **Consistent Terminology**: Maintain consistent use of terminology
+      throughout the book to avoid confusion.
 
 3. **Learning Aids**:
 
-    - **Diagrams and Figures**: Employ diagrams, figures, and tables to visually convey complex concepts.
-    - **Sidebars**: Use sidebars for additional information, anecdotes, or to provide real-world context to the theoretical content.
+    - **Diagrams and Figures**: Employ diagrams, figures, and tables to visually
+      convey complex concepts.
+    - **Sidebars**: Use sidebars for additional information, anecdotes, or to
+      provide real-world context to the theoretical content.
 
 4. **Interactive Elements**:
 
-    - **Exercises and Projects**: Integrate exercises and projects at the end of each chapter to encourage active learning and practical application of concepts.
-    - **Case Studies**: Incorporate case studies to provide a deeper understanding of how principles are applied in real-world situations.
+    - **Exercises and Projects**: Integrate exercises and projects at the end of
+      each chapter to encourage active learning and practical application of
+      concepts.
+    - **Case Studies**: Incorporate case studies to provide a deeper
+      understanding of how principles are applied in real-world situations.
 
 5. **References and Further Reading**:
 
-    - **Bibliography**: Include a bibliography at the end of each chapter for readers who wish to delve deeper into specific topics.
-    - **Citations**: Maintain a consistent style for citations, adhering to recognized academic standards like APA, MLA, or Chicago.
+    - **Bibliography**: Include a bibliography at the end of each chapter for
+      readers who wish to delve deeper into specific topics.
+    - **Citations**: Maintain a consistent style for citations, adhering to
+      recognized academic standards like APA, MLA, or Chicago.
 
 6. **Supporting Materials**:
 
-    - **Supplementary Online Resources**: Provide links to supplementary online resources, such as video lectures, webinars, or interactive modules.
-    - **Datasets and Code Repositories**: Share datasets and code repositories for hands-on practice, particularly for sections dealing with algorithms and applications.
+    - **Supplementary Online Resources**: Provide links to supplementary online
+      resources, such as video lectures, webinars, or interactive modules.
+    - **Datasets and Code Repositories**: Share datasets and code repositories
+      for hands-on practice, particularly for sections dealing with algorithms
+      and applications.
 
 7. **Feedback and Community Engagement**:
 
-    - **Forums and Discussion Groups**: Establish forums or discussion groups where readers can interact, ask questions, and share knowledge.
-    - **Open Review Process**: Implement an open review process, inviting feedback from the community to continuously improve the content.
+    - **Forums and Discussion Groups**: Establish forums or discussion groups
+      where readers can interact, ask questions, and share knowledge.
+    - **Open Review Process**: Implement an open review process, inviting
+      feedback from the community to continuously improve the content.
 
 8. **Inclusivity and Accessibility**:
 
-    - **Inclusive Language**: Utilize inclusive language that respects diversity and promotes equality.
-    - **Accessible Formats**: Ensure the textbook is available in accessible formats, including audio and Braille, to cater to readers with disabilities.
+    - **Inclusive Language**: Utilize inclusive language that respects diversity
+      and promotes equality.
+    - **Accessible Formats**: Ensure the textbook is available in accessible
+      formats, including audio and Braille, to cater to readers with
+      disabilities.
 
 9. **Index**:
-    - **Comprehensive Index**: Include a comprehensive index at the end of the book to help readers quickly locate specific information.
+    - **Comprehensive Index**: Include a comprehensive index at the end of the
+      book to help readers quickly locate specific information.
 
-Implementing these conventions can contribute to creating a textbook that is comprehensive, accessible, and conducive to effective learning.
+Implementing these conventions can contribute to creating a textbook that is
+comprehensive, accessible, and conducive to effective learning.