README Expert - Type Expert for README Documents
Identifies README files - project introduction and orientation documents that provide overview, setup instructions, and quick navigation.
Key signals:
- README in filename
- Project overview/description sections
- Installation/setup instructions
- Quick start sections
- Badge/shield images
- License and contributing references
File: readme_expert.py
Classes
ReadmeExpert
Expert for identifying README documents.
Functions
analyze(document, analyst_votes)
Analyze if document is a README.
generate_enhancements(document, analysis)
Generate enhancements for README documents.