January 2025 updates

README.md

@@ -4,7 +4,7 @@ emoji: 🐨
 colorFrom: green
 colorTo: green
 sdk: gradio
-sdk_version: 5.8.0
+sdk_version: 5.9.1
 app_file: app.py
 pinned: false
 ---
@@ -17,17 +17,15 @@ pinned: false
 ## 1. Introduction
 
 ### Purpose  
-The **Document Checker Tool** aims to:  
-- Improve consistency and compliance with FAA and regulatory guidelines.  
-- Automate tedious manual checks, providing faster and more accurate results.  
-- Enhance clarity and professionalism in FAA documentation.
+The **Document Checker Tool** streamlines the review process by:  
+- Enhancing consistency and compliance with FAA and regulatory standards.  
+- Automating manual checks for improved speed and accuracy.  
+- Improving clarity and professionalism in FAA documents.
 
-This tool provides **suggestions**, but the final editorial decisions rest with the document author.  
+This tool provides **recommendations** to aid document authors, who retain final decision-making authority.  
 
 ### Scope  
-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:  
+Supports all FAA document types covered by AIR-646, with checks aligned to:  
 - GPO Style Manual  
 - FAA Orders  
 - Document Drafting Handbook  
@@ -38,74 +36,69 @@ The tool adheres to style and guidelines derived from:
 
 ## 2. Revision History
 
-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.
+- **1/5/2025:** Added checks for 508 accessibility, heading levels, cross-references, and broken links. Updated the acronym checker for better accuracy.  
+- **12/8/2024:** Added paragraph and sentence length checks. Reorganized checks for workflow improvements. 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. **Terminology Checks**
-4. **Acronym Check**  
-5. **Acronym Usage Check**  
-6. **Section Symbol (§) Checks**  
-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**
+### Key Checker Categories  
+1. Readability Check
+2. Heading Title Checks  
+3. Heading Period Format Check  
+4. Terminology Checks  
+5. Acronym Check  
+6. Acronym Usage Check  
+7. Section Symbol (§) Checks  
+8. 508 Compliance Check (basic checks)  
+9. Cross Reference Check  
+10. Broken Link Check  
+11. Date Format Consistency Check  
+12. Placeholder Content Check  
+13. Referenced Document Title Format Check  
+14. Table Caption Check  
+15. Figure Caption Check  
+16. Table/Figure Reference Check  
+17. Parenthesis Balance Check  
+18. Double Period Check  
+19. Spacing Check  
+20. Paragraph Length Check
+21. Sentence Length Check
 
 ---
 
 ## 4. Details of Each Checker  
 
-### Heading Checks  
-
-#### 1. Required Heading Title Check  
-Verifies required headings are present and properly formatted based on document type.  
+### 1. Readability Check
+Analyzes document readability using multiple metrics including Flesch Reading Ease, Flesch-Kincaid Grade Level, and Gunning Fog Index. Also checks for passive voice usage and technical jargon.
 
-**Examples:**  
+---
 
-- **Advisory Circulars:**  
-  - Purpose  
-  - Applicability  
-  - Cancellation  
-  - Related Material  
-  - Definition of Key Terms  
+### Heading Checks  
 
-- **Federal Register Notice:**  
-  - Purpose of This Notice  
-  - Audience  
-  - Where Can I Find This Notice  
+#### 2. Heading Title Check  
+Verifies required headings are present and formatted according to document type. Note that for ACs, if the AC cancels another AC, you need the Cancellation paragraph. If it doesn't cancel another AC, then you don't need it.  
 
-- **Order:**  
-  - Purpose of This Order  
-  - Audience  
-  - Where to Find This Order  
+**Examples:**  
+- **Advisory Circulars:** Purpose, Applicability, Cancellation, Related Material, Definition of Key Terms  
+- **Federal Register Notice:** Purpose of This Notice, Audience, Where to Find This Notice  
+- **Orders:** Purpose of This Order, Audience, Where to Find This Order  
 
-#### 2. Heading Period Format Check  
-Ensures headings have or do not have periods based on document type.  
+#### 3. Heading Period Format Check  
+Verifies if headings include or omit periods based on document type.  
 
 **Examples:**  
-- **Required Period:** Advisory Circular, Order, Technical Standard Order  
-- **No Period:** All other document types  
+- **Requires Periods:** Advisory Circulars, Orders, Technical Standard Orders  
+- **No Periods:** Other document types  
 
 ---
 
 ### Terminology Checks  
 
-#### 3. Terminology Usage Check  
-Flags outdated or vague terms and enforces FAA terminology standards.  
+#### 4. Terminology Usage Check  
+Flags non-compliant or outdated terms, ensuring adherence to FAA terminology standards.  
 
 **Examples:**  
 - Replace "shall" with "must" per GPO Style Manual.  
@@ -115,117 +108,112 @@ 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 Check  
+Verifies acronyms are defined upon first use.  
+
+**Example:** Federal Aviation Administration (FAA)  
 
-#### 5. Acronym Usage Check  
-Identifies acronyms defined but not used.  
+#### 6. Acronym Usage Check  
+Identifies acronyms that are defined but not subsequently used.  
 
 ---
 
 ### Section Symbol (§) Checks  
 
-#### 6. Section Symbol Usage Check  
-Ensures proper formatting for section symbols.  
+#### 7. Section Symbol Usage Check  
+Ensures section symbols are formatted correctly.  
 
 **Examples:**  
-- Replace "14 CFR § 21.21" with "14 CFR 21.21".  
-- Replace "§ 25.25 and 25.26" with "§§ 25.25 and 25.26".  
+- Use "14 CFR 21.21" instead of "14 CFR § 21.21".  
+- Use "§§ 25.25 and 25.26" for multiple references.  
 
 ---
 
-### Date Format and Placeholder Checks  
-
-#### 7. 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".  
+### 508 Compliance Check  
 
-#### 8. Placeholder Content Check  
-Flags placeholders like "TBD" or "To be added."  
+#### 8. 508 Compliance Checks  
+- Detects images missing alternative text
+- Identifies skipped heading structures
+- Flags hyperlinks that lack descriptive text indicating their destination.
 
 ---
 
-### Document Title Checks  
+### Reference Checks  
 
-#### 9. Referenced Document Title Format Check  
-Verifies correct formatting of referenced document titles.  
+#### 9. Cross Reference Check  
+Validates that all references to paragraphs, appendices, tables, or figures exist in the document.  
 
-- **Italicize:** Advisory Circulars  
-- **Quotation Marks:** All other document types
+#### 10. Broken Link Check  
+Identifies non-functional or broken hyperlinks.  
 
 ---
 
-### Table and Figure Checks  
+### Date and Placeholder Checks  
 
-#### 10 & 11. Table/Figure Caption Checks  
-Verifies captions follow correct numbering conventions based on document type.
+#### 11. Date Format Consistency Check  
+Ensures date formatting matches the "Month Day, Year" convention.  
 
 **Examples:**  
-- Table X-Y and Figure X-Y for Advisory Circulars and Orders.  
-- Table X and Figure X for all other document types.
+- Correct "1/15/24" to "January 15, 2024".  
 
-#### 12. Table/Figure Reference Check  
-Ensures references are lowercase mid-sentence and capitalized at the start of a sentence.  
+#### 12. Placeholder Content Check  
+Flags placeholders like "TBD" or "To be added".  
 
 ---
 
-### Parenthesis Balance Check  
+### Document Title Checks  
 
-#### 13. Parenthesis Balance Check  
-Verifies that all parentheses are properly opened and closed.  
+#### 13. Referenced Document Title Format Check  
+Checks formatting of referenced document titles.  
 
 **Examples:**  
-- Add a missing closing parenthesis to "The system (as defined in AC 25-11B performs...".
+- **Italicized:** Advisory Circulars  
+- **Quotation Marks:** Other document types  
 
 ---
 
-### Punctuation and Spacing Checks  
-
-#### 14. Double Period Check  
-Flags unintended multiple periods.  
+### Table and Figure Checks  
 
-**Example:**  
-- Corrects: "This sentence ends with two periods..".  
+#### 14. Table Caption Check  
+Ensures table captions follow numbering conventions by document type.  
 
-#### 15. Spacing Check  
-Ensures proper spacing around references.  
+#### 15. Figure Caption Check  
+Verifies figure captions adhere to proper numbering.  
 
-**Examples:**  
-- Replace "AC25.1" with "AC 25.1".  
-- Remove double spaces between words or after periods.  
+#### 16. Table/Figure Reference Check  
+Checks capitalization of references depending on placement in a sentence.  
 
 ---
 
-### Length Checks  
+### Syntax and Punctuation Checks  
 
-#### 16. Paragraph Length Check  
-Flags paragraphs exceeding 6 sentences or 8 lines.  
+#### 17. Parenthesis Balance Check  
+Ensures parentheses are properly paired.  
 
-#### 17. Sentence Length Check  
-Flags sentences exceeding 35 words.  
+**Example:** Corrects "(as defined in AC 25-11B performs..." to include a closing parenthesis.  
 
----
+#### 18. Double Period Check  
+Identifies unintended multiple periods.  
+
+**Example:** Corrects "ends with two periods..".  
 
-## 5. Practical Applications  
+#### 19. Spacing Check  
+Verifies consistent spacing around references and sentences.  
 
-1. **Efficient Document Review:** Automated checks save time and reduce errors.  
-2. **Consistency Across Documents:** Ensures adherence to FAA standards.  
-3. **Enhanced Collaboration:** Simplifies document updates for teams.  
+**Examples:**  
+- Correct "AC25.1" to "AC 25.1".  
+- Remove extra spaces after periods.  
 
 ---
 
-## 6. Conclusion and Future Updates  
+### Length Checks  
+
+#### 20. Paragraph Length Check  
+Flags paragraphs exceeding six sentences or eight lines.  
 
-### Key Takeaways  
-- Automated checkers enhance accuracy and compliance.  
-- Tailored for FAA documentation needs.  
-- Saves time while improving document quality.  
+#### 21. Sentence Length Check  
+Highlights sentences longer than 35 words.  
 
-### What's Next?  
-- Continue refining the tool to improve accuracy and functionality.  
-- 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.