From ea0d03da102ad1b9f4f31ef6d89d9e3f87435ae4 Mon Sep 17 00:00:00 2001 From: Codechu Date: Sat, 29 Aug 2026 17:59:19 +0300 Subject: [PATCH] Render the way a README renders, and drop a rule that was an artefact MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Every rendering rule in §7.1 was found by rendering through `gh api /markdown` — under `mode: "gfm"`, which is comment semantics, not README semantics. The two disagree about the one thing those rules are mostly about: under gfm every single newline becomes a `
` and no heading anchors are emitted; under `mode: "markdown"` newlines inside a paragraph join and headings carry the anchors that in-page links need. One file measured 116 `
` outside code under gfm and zero under markdown. Verifying a README under gfm shows a page no reader will see, and hides exactly the line-collapse the couplet rule exists for. The couplet rule survives — it is true under the correct mode. "All badges on one source line" does not: paragraph lines join on their own, so it described the verification artefact rather than the page. What remains is the part that was always real, that every badge is a link. --- STANDARDS.md | 14 ++++++++++++-- STANDARDS.tr.md | 14 ++++++++++++-- overlay/PUBLISHED-VERDICT.md | 5 +++-- project-type/TOOL.md | 2 +- 4 files changed, 28 insertions(+), 7 deletions(-) diff --git a/STANDARDS.md b/STANDARDS.md index e580a2e..ad1e97c 100644 --- a/STANDARDS.md +++ b/STANDARDS.md @@ -237,8 +237,18 @@ block or reference an `assets/` file. The per-project-type docs type-specific skeletons. **Rendering rules (measured, not assumed).** Each of these was found by -rendering a README through `gh api /markdown` and looking at the page; -none of them are visible while reading the markdown source. +rendering a README and looking at the page; none of them are visible +while reading the markdown source. + +**Render it the way a README is rendered.** `gh api /markdown` takes a +`mode`, and the two modes disagree about the thing most of these rules +are about. `mode: "gfm"` is *comment* semantics: every single newline +becomes a `
`, and no heading anchors are emitted. `mode: "markdown"` +is what a README gets: newlines inside a paragraph join, and headings +carry the anchors that in-page links depend on. *Measured on one file: +116 `
` outside code under gfm, zero under markdown.* Verifying a +README under gfm shows you a page no reader will see — and it hides +exactly the line-collapse the next rule is about. - **The README is not the fold on a GitHub repository page.** *Measured on a 1090 px-wide capture: the README began ~1080 px down; the first diff --git a/STANDARDS.tr.md b/STANDARDS.tr.md index aeb1db5..f9c03ba 100644 --- a/STANDARDS.tr.md +++ b/STANDARDS.tr.md @@ -241,8 +241,18 @@ bloğu ya da `assets/` referansı şart. Proje-tipi rehberleri tip-spesifik iskeletlerle yeniden ifade eder. **Render kuralları (ölçüldü, varsayılmadı).** Aşağıdakilerin hepsi bir -README'yi `gh api /markdown` ile render edip sayfaya BAKARAK bulundu; -hiçbiri markdown kaynağı okunurken görünmüyor. +README render edilip sayfaya BAKARAK bulundu; hiçbiri markdown kaynağı +okunurken görünmüyor. + +**README nasıl render ediliyorsa öyle render et.** `gh api /markdown` +bir `mode` alıyor ve iki mod, bu kuralların asıl konusunda birbirine +zıt. `mode: "gfm"` YORUM semantiğidir: her tek satır sonu `
` olur ve +başlık çapası hiç üretilmez. `mode: "markdown"` README'nin aldığıdır: +paragraf içindeki satırlar birleşir, başlıklar sayfa-içi linklerin +dayandığı çapaları taşır. *Tek dosyada ölçüldü: gfm'de kod dışında 116 +`
`, markdown'da sıfır.* README'yi gfm ile doğrulamak, hiçbir okurun +görmeyeceği bir sayfaya bakmaktır — üstelik bir sonraki kuralın konusu +olan satır-çökmesini tam da gizler. - **GitHub repo sayfasında fold README değildir.** *1090 px genişlikte ölçüldü: README ~1080 px aşağıda başlıyor; ilk ekran dosya listesi ve diff --git a/overlay/PUBLISHED-VERDICT.md b/overlay/PUBLISHED-VERDICT.md index 725aba3..cbe6644 100644 --- a/overlay/PUBLISHED-VERDICT.md +++ b/overlay/PUBLISHED-VERDICT.md @@ -67,7 +67,8 @@ defends.** # Repo-Name -[badge row — ALL badges on ONE source line, EVERY badge linked] +[badge row — EVERY badge linked; source lines may be separate, + they join in a paragraph] *[tagline — one italic sentence]* @@ -213,7 +214,7 @@ when a cross-reference dies. ## 10. Checklist - [ ] Hero alone on the first screen; no second image competing -- [ ] Badge row on one source line, every badge linked +- [ ] Every badge in the row is a link - [ ] Lede names the runtime ("Python", "stdlib-only") — grep for it - [ ] Status stamp above the fold, full `## Status` in the lower third - [ ] `## Run it` present, fenced, language-tagged, and offline diff --git a/project-type/TOOL.md b/project-type/TOOL.md index e4314c9..6ab4cc4 100644 --- a/project-type/TOOL.md +++ b/project-type/TOOL.md @@ -103,7 +103,7 @@ a tool-flavoured skeleton: # tool-name -[badge row — one source line, every badge linked] +[badge row — every badge linked] *[tagline — one italic sentence]*