codefori/vscode-ibmi

Developer documentation needs improving

Open

#1,892 opened on Feb 29, 2024

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)TypeScript (153 forks)auto 404
documentationgood first issue

Repository metrics

Stars
 (414 stars)
PR merge metrics
 (PR metrics pending)

Description

Has references to APIs that don't exist anymore or are deprecated

  • code-for-ibmi.runCommand becomes connection.runCommand :+1:

Contributor guide

Research direction
Find the developer documentation files in the repository. Search for all references to the deprecated API `code for ibmi.runCommand` and replace them with `connection.runCommand`. Also look for any other outdated or deprecated API references in the docs.
Tech stack
typescript
Domain
developer experience
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80