Follow-up from the docs review of #1333 (which cleaned up CONTRIBUTING.md). Two related items remain, in scope outside that PR:
-
README.md still names the old repo. The title is # ponylang.github.io; the repo is now ponylang/ponylang-website. Update the title and any other stale repo-name references in the README.
-
The local-install instructions are incomplete. CONTRIBUTING.md tells contributors to pip install mkdocs, but the site depends on plugins pinned in requirements.txt (mkdocs-material, mkdocs-ezlinks-plugin, mkdocs-rss-plugin, mkdocs-llmstxt). A bare pip install mkdocs fails at mkdocs serve with a plugin-not-found error. The install step should use pip install -r requirements.txt (ideally in a virtualenv).
Note: item 2 overlaps with separate, deferred work to document how contributors verify the site locally (a Docker-based "Local Verification" section). Whoever picks this up should coordinate the two so the local-build guidance lives in one place.
Follow-up from the docs review of #1333 (which cleaned up
CONTRIBUTING.md). Two related items remain, in scope outside that PR:README.mdstill names the old repo. The title is# ponylang.github.io; the repo is nowponylang/ponylang-website. Update the title and any other stale repo-name references in the README.The local-install instructions are incomplete.
CONTRIBUTING.mdtells contributors topip install mkdocs, but the site depends on plugins pinned inrequirements.txt(mkdocs-material,mkdocs-ezlinks-plugin,mkdocs-rss-plugin,mkdocs-llmstxt). A barepip install mkdocsfails atmkdocs servewith a plugin-not-found error. The install step should usepip install -r requirements.txt(ideally in a virtualenv).Note: item 2 overlaps with separate, deferred work to document how contributors verify the site locally (a Docker-based "Local Verification" section). Whoever picks this up should coordinate the two so the local-build guidance lives in one place.