Redocly / Redocly/redocly-cli

Update resources links for rules

Open
#1,752 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Type: Docs
Dominant language
TypeScript
Stars
1.5k
Forks
228
Avg merge
1d 14h
Merged PRs (30d)
48

Description

Many of the rules documentation pages link to the code source for the rule. Instead, let's link to our other resources on related topics or similar rules. Linking to the code isn't user friendly.

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

Locate the rules documentation pages referenced by the issue and review their current links to rule source code. Replace those links with relevant resources on related topics or similar rules, then verify that the updated documentation links are valid and user-facing.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.