Added release history, reorganized checks, added paragraph and sentence length checks

README.md

@@ -4,7 +4,7 @@ emoji: 🐨
 colorFrom: green
 colorTo: green
 sdk: gradio
-sdk_version: 5.6.0
+sdk_version: 5.8.0
 app_file: app.py
 pinned: false
 ---
@@ -25,7 +25,7 @@ The **Document Checker Tool** aims to:
 This tool provides **suggestions**, but the final editorial decisions rest with the document author.  
 
 ### Scope  
-The tool supports all FAA document types AIR-646 supports and includes 15 categories of checks. 
+The tool supports all FAA document types AIR-646 supports and includes multiple categories of checks. 
 
 The tool adheres to style and guidelines derived from:  
 - GPO Style Manual  
@@ -36,28 +36,37 @@ The tool adheres to style and guidelines derived from:
 
 ---
 
-## 2. Checker Categories Overview  
+## 2. Revision History
 
-### 15 Key Checker Categories  
+12/8/2024: Added checks for paragraph length and sentence length. Reordered existing checks for improved workflow. Updated the date format check to exclude certain AC numbers.
+11/26/2024: Initial release with 15 checks.
+
+---
+
+## 3. Checker Categories Overview  
+
+### 17 Key Checker Categories  
 1. **Heading Title Checks**  
-2. **Heading Period Format Check**  
-3. **Acronym Check**  
-4. **Acronym Usage Check**  
-5. **Terminology Checks**  
+2. **Heading Period Format Check**
+3. **Terminology Checks**
+4. **Acronym Check**  
+5. **Acronym Usage Check**  
 6. **Section Symbol (§) Checks**  
-7. **Table Caption Check**  
-8. **Figure Caption Check**  
-9. **Table/Figure Reference Check**  
-10. **Referenced Document Title Format Check**  
-11. **Double Period Check**  
-12. **Spacing Check**  
-13. **Date Format Check**  
-14. **Placeholder Content Check**  
-15. **Parenthesis Balance Check**
+7. **Date Format Check**
+8. **Placeholder Content Check**
+9. **Referenced Document Title Format Check**  
+10. **Table Caption Check**  
+11. **Figure Caption Check**  
+12. **Table/Figure Reference Check**  
+13. **Parenthesis Balance Check**
+14. **Double Period Check**
+15. **Spacing Check**  
+16. **Paragraph Length Check**  
+17. **Sentence Length Check**
 
 ---
 
-## 3. Details of Each Checker  
+## 4. Details of Each Checker  
 
 ### Heading Checks  
 
@@ -92,20 +101,9 @@ Ensures headings have or do not have periods based on document type.
 
 ---
 
-### Acronym and Abbreviation Checks  
-
-#### 3. Acronym Check  
-Ensures acronyms are defined at first use.  
-- **Example:** Federal Aviation Administration (FAA)  
-
-#### 4. Acronym Usage Check  
-Identifies acronyms defined but not used.  
-
----
-
 ### Terminology Checks  
 
-#### 5. Terminology Usage Check  
+#### 3. Terminology Usage Check  
 Flags outdated or vague terms and enforces FAA terminology standards.  
 
 **Examples:**  
@@ -114,6 +112,17 @@ Flags outdated or vague terms and enforces FAA terminology standards.
 
 ---
 
+### Acronym and Abbreviation Checks  
+
+#### 4. Acronym Check  
+Ensures acronyms are defined at first use.  
+- **Example:** Federal Aviation Administration (FAA)  
+
+#### 5. Acronym Usage Check  
+Identifies acronyms defined but not used.  
+
+---
+
 ### Section Symbol (§) Checks  
 
 #### 6. Section Symbol Usage Check  
@@ -125,23 +134,22 @@ Ensures proper formatting for section symbols.
 
 ---
 
-### Table and Figure Checks  
+### Date Format and Placeholder Checks  
 
-#### 7 & 8. Table/Figure Caption Checks  
-Verifies captions follow correct numbering conventions based on document type.
+#### 7. Date Format Consistency Check  
+Ensures dates follow the "Month Day, Year" format in the document body.  
 
 **Examples:**  
-- Table X-Y and Figure X-Y for Advisory Circulars and Orders.  
-- Table X and Figure X for all other document types.
+- Replace "1/15/24" with "January 15, 2024".  
 
-#### 9. Table/Figure Reference Check  
-Ensures references are lowercase mid-sentence and capitalized at the start of a sentence.  
+#### 8. Placeholder Content Check  
+Flags placeholders like "TBD" or "To be added."  
 
 ---
 
 ### Document Title Checks  
 
-#### 10. Referenced Document Title Format Check  
+#### 9. Referenced Document Title Format Check  
 Verifies correct formatting of referenced document titles.  
 
 - **Italicize:** Advisory Circulars  
@@ -150,15 +158,39 @@ Verifies correct formatting of referenced document titles.
 
 ---
 
+### Table and Figure Checks  
+
+#### 10 & 11. Table/Figure Caption Checks  
+Verifies captions follow correct numbering conventions based on document type.
+
+**Examples:**  
+- Table X-Y and Figure X-Y for Advisory Circulars and Orders.  
+- Table X and Figure X for all other document types.
+
+#### 12. Table/Figure Reference Check  
+Ensures references are lowercase mid-sentence and capitalized at the start of a sentence.  
+
+---
+
+### Parenthesis Balance Check  
+
+#### 13. Parenthesis Balance Check  
+Verifies that all parentheses are properly opened and closed.  
+
+**Examples:**  
+- Add a missing closing parenthesis to "The system (as defined in AC 25-11B performs...".
+
+---
+
 ### Punctuation and Spacing Checks  
 
-#### 11. Double Period Check  
+#### 14. Double Period Check  
 Flags unintended multiple periods.  
 
 **Example:**  
 - Corrects: "This sentence ends with two periods..".  
 
-#### 12. Spacing Check  
+#### 15. Spacing Check  
 Ensures proper spacing around references.  
 
 **Examples:**  
@@ -167,30 +199,17 @@ Ensures proper spacing around references.
 
 ---
 
-### Date Format and Placeholder Checks  
-
-#### 13. Date Format Consistency Check  
-Ensures dates follow the "Month Day, Year" format in the document body.  
-
-**Examples:**  
-- Replace "1/15/24" with "January 15, 2024".  
-
-#### 14. Placeholder Content Check  
-Flags placeholders like "TBD" or "To be added."  
-
----
-
-### Parenthesis Balance Check  
+### Length Checks  
 
-#### 15. Parenthesis Balance Check  
-Verifies that all parentheses are properly opened and closed.  
+#### 16. Paragraph Length Check  
+Flags paragraphs exceeding 6 sentences or 8 lines.  
 
-**Examples:**  
-- Add a missing closing parenthesis to "The system (as defined in AC 25-11B performs...".  
+#### 17. Sentence Length Check  
+Flags sentences exceeding 35 words.  
 
 ---
 
-## 4. Practical Applications  
+## 5. Practical Applications  
 
 1. **Efficient Document Review:** Automated checks save time and reduce errors.  
 2. **Consistency Across Documents:** Ensures adherence to FAA standards.  
@@ -198,7 +217,7 @@ Verifies that all parentheses are properly opened and closed.
 
 ---
 
-## 5. Conclusion and Future Updates  
+## 6. Conclusion and Future Updates  
 
 ### Key Takeaways  
 - Automated checkers enhance accuracy and compliance.  
@@ -207,7 +226,6 @@ Verifies that all parentheses are properly opened and closed.
 
 ### What's Next?  
 - Continue refining the tool to improve accuracy and functionality.  
-- Explore adding new checks based on user feedback and evolving guidelines.  
-- Investigate ignoring specific sections like the Table of Contents for better results.  
+- Explore adding new checks based on user feedback and evolving guidelines.    
 
-**Note:** This tool is a work in progress. Expect more features and updates in the future to meet evolving document requirements.
+**Note:** This tool is a work in progress. Expect more features and updates in the future to meet evolving document requirements.