roc-lang / roc-lang/examples

link to docs when talking about functions in the markdown files

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

Nobody has claimed this yet.

Dominant language
Shell
Stars
46
Forks
19
Avg merge
13h 38m
Merged PRs (30d)
19

Description

For example Task.await should link to https://www.roc-lang.org/packages/basic-cli/0.6.0/Task#await

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

Search the repository's Markdown files for references to functions such as Task.await. Use the linked basic-cli documentation URL as the target for the example, and consider the surrounding function references consistently. Done means the relevant function mentions link to their corresponding documentation pages.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.