Point the verification docs at the package README instead of its lessons page

Open
#135 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Active
Tech stack
markdown
Domain
documentation

Research direction

The links to change are in docs/verification/automation.md, docs/verification/README.md and AGENTS.md, which currently point at lessons.md on main. Do not start until nemchik/suitescript-verify#13 is released and this repo pins that version. Then repoint each link to the installed package README and run npm test to confirm the link checks pass.

Written by the indexing model from the issue text.

Description

needs-triage

Problem

docs/verification/automation.md and AGENTS.md tell agents to read the package's docs/verification/lessons.md on main. That link is not versioned with the pinned suitescript-verify dependency, so the guidance can change under us.

The package will move the lessons into its README so they ship with each version: nemchik/suitescript-verify#13.

Acceptance criteria

  • nemchik/suitescript-verify#13 is released and this repo pins that version.
  • docs/verification/automation.md, docs/verification/README.md and AGENTS.md point to the package README (the installed version), not lessons.md on main.
  • npm test link checks pass.

Blocked by nemchik/suitescript-verify#13. Part of the later tidy of agent knowledge for the package split.

Dominant language
TypeScript
Stars
1
Forks
0
Avg merge
2h 8m
Merged PRs (30d)
64

Getting set up

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 nemchik/biome-plugin-suitescript

All issues in nemchik/biome-plugin-suitescript

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.