You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
policy(docs): README must be Markdown (not AsciiDoc) (#427)
README renders in GitHub **community-health**, the GitHub **profile**
(profile READMEs render *only* `README.md`), and external **MCP
directories (Glama)** — all show AsciiDoc as raw markup (confirmed live
on glama.ai/.../boj-server). So README joins the GitHub-required-`.md`
set: `README.md` is canonical, a `README.adoc` alongside it is a
duplicate to remove. Replaces the earlier
`.adoc`-primary-with-Glama-carve-out rule for README (which only helped
repos with `glama.json` and still kept .adoc canonical).
`doc-format.yml` + the CLAUDE.md policy updated. The estate-wide
README.adoc→.md conversion sweep (#2) follows; the profile (#29) and
boj-server (#260) are already converted.
Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
-**README must be `.md`, not `.adoc`.** README renders in GitHub community-health, the GitHub profile page (profile READMEs *only* render `README.md`), and external MCP directories (Glama) — all of which show AsciiDoc as raw markup. Keep `README.md`; do not keep a `README.adoc` alongside it. (This replaces the earlier `.adoc`-primary-with-Glama-carve-out rule for README.)
172
+
- No duplicate formats for the `.adoc`-primary docs (if `ARCHITECTURE.adoc` etc. exists, don't also have `.md`)
# README must be Markdown. A lone README.adoc renders as raw markup in
71
+
# community-health/profile/Glama — nudge to convert (warning during the
72
+
# estate-wide migration; the duplicate case above is the hard error).
73
+
if [ -f "README.adoc" ] && [ ! -f "README.md" ]; then
74
+
echo "::warning::README.adoc without README.md — README must be Markdown (renders raw as AsciiDoc in community-health/profile/Glama). Convert to README.md."
0 commit comments