Skip to content

README.md is an unlinked duplicate of the homepage, not excluded from the site build #53

Description

@lyzhang0113

Found while reviewing docs in PR #30.

File: README.md

This is a full Jekyll page (frontmatter with layout: default-layout, title/description/keywords, an inline-CSS product-tile grid) — not a plain repo-contributor README. Findings:

  • Nothing in the repo links to it (checked .md/.html/.yml repo-wide).
  • _config.yml has no exclude: list, and the only sitemap: false default is scoped to Hide_Tree_Page.html — so with jekyll-sitemap enabled, /faq/README.html ships in the sitemap and gets crawled by the Crawler-FAQ-Docs search index, alongside index.md which is a near-duplicate homepage.
  • As a bonus wrinkle, GitHub itself strips <style> blocks when rendering READMEs on the repo page, so it doesn't even display correctly as a GitHub landing page.

Decide whether to: add sitemap: false, exclude it from the Jekyll build entirely, merge its content into index.md, or leave it as-is.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions