Monorepo for Tangled tangled.org

README picker takes first README and overrides README.md in web render #4684

Open mpadge.eu
Open opened by mpadge.eu
assigned to boltless.me

Repos with multiple README files can end up with the wrong version being rendered. For example, a README.Rmd will be rendered instead of README.md, even if the latter exists. This seems to arise from https://tangled.org/tangled.org/core/blob/master/web/src/lib/api/knotmirror.ts#L188-189 which identifies all candidates, but then passes to a simple .find() at https://tangled.org/tangled.org/core/blob/master/web/src/lib/api/knotmirror.ts#L201. That takes the first candidate, and .Rmd is sorted before .md.

Could you please update to explicitly use README.md if it exists, and fallback to current behaviour only if not? Thanks!

Related issue:https://tangled.org/tangled.org/core/issues/741

Sign up or Sign in to add to the discussion.