RealDevSquad / RealDevSquad/website-backend

Broken Link in README.md

Open
#2,073 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
74
Forks
276
Avg merge
1d 26m
Merged PRs (30d)
14

Description

Issue Description

Link on API Documentation is broken, points to no where

Expected Behavior

It should point to website-api-contract

Current Behavior

An anchor is link there, redirecting nowhere

Screenshots

image

Reproducibility
  • This issue is reproducible
  • This issue is not reproducible
Steps to Reproduce
  1. Visting README.me and clicking on Api Documentation Link in table of content
Severity/Priority
  • Critical
  • High
  • Medium
  • Low
Checklist
  • I have read and followed the project's code of conduct.
  • I have searched for similar issues before creating this one.
  • I have provided all the necessary information to understand and reproduce the issue.
  • I am willing to contribute to the resolution of this issue.

Contributor guide

Open the 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.

Research direction

Open README.md and inspect the API Documentation link in the table of contents. Verify the current anchor target and update the link so it points to website-api-contract, then confirm that clicking it reaches the intended page.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.