scarletkc/seiso
A Markdown convention and linter for project docs written by AI and read by humans and agents
Hızlı değerlendirme
Özet
seiso, proje dokümantasyonundaki Markdown dosyalarını tanımlı bir yazım ve yapı kuralına göre denetleyen bir CLI linter'dır.
Profiline uyum
AI agent’lar ve RAG kullandığınız için güncel, tutarlı proje dokümantasyonuna dolaylı katkı sağlar; ancak profilinizde doğrudan bir dokümantasyon lintleme ihtiyacı yok.
Neden yükseliyor
AI tarafından üretilen dokümantasyonun doğruluğu ve coding agents için güvenilir bağlam ihtiyacı güncel bir sorun. Repo bir günlükken 74 yıldıza ulaşmış; bu ilk ilgiyi gösterir, ancak kalite veya benimseme kanıtı değildir. Son 28 günlük commit ve farklı yazar verisi ölçülmemiş.
Problem
Dokümantasyonun AI tarafından hızlı üretilmesi veya güncellenmesi; eski bilgilerin kalmasına, aynı bilginin farklı sayfalarda tutarsız biçimde yer almasına ve coding agents için yanıltıcı bağlam oluşmasına yol açabilir.
Çözüm
Depodaki Markdown belgelerini belge türleri ve dokümantasyon kuralları açısından tarar; bulguların konumunu ve düzeltme yönünü bildirir. Kuralların bir bölümü varsayılan olarak çalışırken deneysel kurallar `--preview` ile seçilir.
Yenilik
Genel biçimlendirme veya yazım denetiminden farklı olarak belge türü, bilginin tek bir yerde tutulması ve değişken verilerin uzun ömürlü sayfalarda yer almaması gibi dokümantasyon ilkelerini lint kurallarına dönüştürmesi ayırt edici. Yaklaşımın yaygın biçimde benimsendiğine dair henüz kanıt yok.
Teknolojiler
- Rust
- Markdown
- CLI
Riskler
- Repo çok yeni; uzun dönemli bakım, gerçek kullanım ve kural kalitesi hakkında yeterli kanıt yok.
- Son 28 günlük commit ve farklı yazar ölçümleri bulunmadığından geliştirme temposu ve katkı çeşitliliği değerlendirilemiyor.
- Belge türü veya bir bilginin hangi sayfaya ait olduğu gibi kurallar ekip bağlamına göre değişebilir; araç bu tür yargıları tamamen otomatikleştirmiyor.
- README, deneysel kuralların yanlış pozitif üretebileceğini belirtiyor ve bunların CI kapısı olarak kullanılmamasını öneriyor.
Detaylı değerlendirme
Bu repo için detaylı değerlendirme henüz yapılmadı. Analiz, Ayarlar'daki uyum profilini hesaba katarak "bu işime yarar mı" sorusunu cevaplıyor. Bir kez çalışır; günlük koşular buna dokunmaz. Saatlik sınır var — bir kaynaktan en fazla 3 analiz.