docs(readme): local preview, prerequisites, owner-wording fix, polish - #19
Merged
Conversation
…olish Improve the README for first-time readers and contributors while keeping its verified-accurate style. Additive, grounded changes only — every new claim was checked against the repo: - Preview: how to view the rendered page locally (index.html is self-contained — 0 runtime fetches, CSS inlined), which was missing for a repo whose product is a rendered page. - Prerequisites: state the toolchain — Node (CI pins 22) and Python 3 (CI pins 3.12) for the validator; cross-reference the pip requirement at the contributor walkthrough's validate step so step-by-step readers don't hit ModuleNotFoundError. - Fix (accuracy): the Files table said "named human owner"; human_owner is a maintainers body, not an individual — reword to "a named maintainers body". - Onboarding: a top "Contributing?" pointer to AGENTS.md + the add-a-service section, and a Contents table for a ~190-line doc. - Nits: descriptive H1 (Mossland Verified Links); registry + assurance CI badges; gloss 최종 확인 as "(last-verified)"; fix a comma splice. README-only; no functional/site or assurance-artifact change. Verified: all in-page anchors + file links resolve (0 broken); v0.5.0 adopter check stays exit 0 / 0 ERROR-WARN. 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
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-only polish. The README was already accurate (an adversarial review found 0 factual errors and 0 broken links across every claim — field lists, the 12-tier enum, the 7 chips, section names, all commands, both CI workflows, precedence subtleties). These changes close a few first-time-reader gaps and one wording inaccuracy, without touching its verified-accurate style. Every new claim was checked against the repo.
Substantive (recommended)
index.htmlhas 0 runtime fetches and inlined CSS, soopen index.htmlworks overfile://..github/workflows/registry.ymllines 23/28); there is nopackage.json/.nvmrc, so CI was the only source. Also cross-referenced thepip install "jsonschema[format-nongpl]"prereq at the contributor walkthrough's validate step (it appeared only once before, so a reader following steps 1–6 could hitModuleNotFoundError).adoption.yamlas recording a "named human owner"; thehuman_owneris a maintainers body (MosslandOpenDevs maintainers), which the adoption file itself distinguishes from "a single named individual." Reworded to "the human owner (a named maintainers body)".AGENTS.md+ the add-a-service section (previously only in the Files table and a buried blockquote).Stylistic (easy to drop if you'd rather not)
registry.yml+assurance.yml. They visualize the README's central "CI enforces this" claim; drop them if you prefer the badge-free look.Mossland Verified Linksinstead of the repo slug); gloss최종 확인as "(last-verified)" to match the KR/EN pairing used everywhere else; fix a comma splice ("this, it is" → "this — it is").Verification
#anchoragainst the heading slugs and every relative link withtest -e; badge workflow files exist).Review
Do not merge without owner review. Docs-only; nothing here is decided by the drafting agent. The substantive items (1–4) and stylistic items (5–7) are separated above so you can cherry-pick during review.