Skip to content

policy(docs): README must be Markdown (not AsciiDoc)#427

Merged
hyperpolymath merged 1 commit into
mainfrom
fix/readme-must-be-markdown
Jun 25, 2026
Merged

policy(docs): README must be Markdown (not AsciiDoc)#427
hyperpolymath merged 1 commit into
mainfrom
fix/readme-must-be-markdown

Conversation

@hyperpolymath

Copy link
Copy Markdown
Owner

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.

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. So README joins the GitHub-required-.md set; README.md is canonical
and a README.adoc alongside it is a duplicate to remove. Replaces the earlier
.adoc-primary-with-Glama-carve-out rule for README. doc-format.yml: README out of
the .adoc-primary duplicate loop; README.md+README.adoc -> hard error (keep .md);
lone README.adoc -> warning (migration nudge). Estate README.adoc->.md conversion
sweep follows.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@hyperpolymath hyperpolymath enabled auto-merge (squash) June 25, 2026 18:45
@hyperpolymath hyperpolymath disabled auto-merge June 25, 2026 18:56
@hyperpolymath hyperpolymath merged commit da1ee5e into main Jun 25, 2026
7 of 16 checks passed
@hyperpolymath hyperpolymath deleted the fix/readme-must-be-markdown branch June 25, 2026 18:57
hyperpolymath added a commit that referenced this pull request Jun 26, 2026
…te (#430)

## Summary

Two owner-directed canon corrections to `.claude/CLAUDE.md`
(2026-06-26).

### 1. README is `.adoc` by default (`843812c`)
Corrects the short-lived `da1ee5e` "README must be Markdown (not
AsciiDoc) (#427)" reversal, which contradicted the rest of the estate
tooling (`rhodibot` deletes stub `README.md` to keep `.adoc`;
contractiles accept `README.adoc`). New rule, per owner directive:

- README is **`.adoc` by default** everywhere, with **exactly two `.md`
exceptions**:
- `hyperpolymath/hyperpolymath` — the GitHub **profile** repo (profile
READMEs render only `README.md`).
- `hyperpolymath/boj-server` — listed in external MCP directories
(Glama), which show AsciiDoc as raw markup.

### 2. Commit-signing note (`887a8ee`)
Documents (ground-truthed) that "Unverified" on agent commits is
**platform-managed and non-blocking** — git's `gpg.ssh.program` points
at Anthropic's `environment-manager` shim, wired once globally; there is
no per-repo/per-container key chore. Prevents future agents (and the
advisory stop-hook) from chasing it or attempting key surgery.

## Notes
- Docs-only; no code or tooling changes.
- Commits show as Unverified due to the platform signing situation
documented in commit 2 (non-blocking).

🤖 Generated with [Claude Code](https://claude.com/claude-code)

https://claude.ai/code/session_018Auxpj3daisp3kTcurBZ8t

---
_Generated by [Claude
Code](https://claude.ai/code/session_018Auxpj3daisp3kTcurBZ8t)_

---------

Co-authored-by: Claude <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant