policy(docs): README must be Markdown (not AsciiDoc)#427
Merged
Conversation
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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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-.mdset:README.mdis canonical, aREADME.adocalongside it is a duplicate to remove. Replaces the earlier.adoc-primary-with-Glama-carve-out rule for README (which only helped repos withglama.jsonand 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.