[Bug]: Fix broken README.md documentation table, dead catalog links, and missing payload-host ESLint ignores

Open Beginner friendly
  • Is something wrong?
#452 1 comment 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
62/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Active
Tech stack
markdown, nextjs
Domain
documentation, tooling

Research direction

Start with the broken table near README.md lines 40-44 and the /catalog links at lines 28-43, then check MIGRATION.md line 56 against fixtures/app/(helmdeck)/catalog/, which only defines page.tsx. For lint, add the two examples/payload-host paths to the ignores in eslint.config.mjs around line 8, then run pnpm lint with the .next directory present. Done when the table renders, no link points to a missing route, and lint passes; the v0 and resource-engine wording needs a decision on the replacement text first.

Written by the indexing model from the issue text.

Description

bug CI documentation good first issue help wanted P2
Area

Generic core

Priority

P2 - Normal priority

Summary

README.md has a broken Markdown table and links to non-existent /catalog/* sub-routes and v0 floating tags, and eslint.config.mjs omits examples/payload-host/.next/** and examples/payload-host/next-env.d.ts from its ignore list.

Reproduction steps
  1. View README.md:40-44 where prose inserted between table rows breaks the Getting started table row.
  2. Follow the /catalog/<slug> links in README.md:28-43 and MIGRATION.md:56 (fixtures/app/(helmdeck)/catalog/ only defines /catalog/page.tsx).
  3. Build examples/payload-host and run pnpm lint (eslint.config.mjs:8 does not ignore examples/payload-host/.next/** or examples/payload-host/next-env.d.ts).
Expected behavior
  • The documentation table in README.md renders cleanly, all links resolve to live routes or sections on https://helmdeck.yesvus.com, and release documentation reflects 1.x (v1) and the Payload-backed starter.
  • eslint.config.mjs ignores examples/payload-host/.next/** and examples/payload-host/next-env.d.ts alongside fixtures, examples/independent-host, and template.
Actual behavior
  • README.md:42 splits the documentation Markdown table in half and links to 404 /catalog/* sub-routes on helmdeck-web.vercel.app.
  • README.md:14,30-32,70-76 still references the retired pre-1.0 resource engine and v0 floating rollout tag.
  • pnpm lint fails if examples/payload-host/.next exists on disk.
Dominant language
TypeScript
Stars
1
Forks
0
Avg merge
2h 8m
Merged PRs (30d)
102

Getting set up

  • No Dockerfile or Docker Compose file
  • Has a pull request template
  • No contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from yesvus/helmdeck

All issues in yesvus/helmdeck

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.