caolan / caolan/highland

[Easy] Improve the Hyper in the docs

Open
#347 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
3.4k
Forks
145
PR merge metrics
No merged PRs in 30d

Description

There are many places where methods or functions are mentioned i the docs. In my opinion they should all be `inline code blocks` and should be [a link](https://youtu.be/dQw4w9WgXcQ), like [`this`](https://youtu.be/dQw4w9WgXcQ).

This is a trivial tasks since you can find what the link should be by browsing the docs.

To build the docs you need the `grunt cli`.

```
npm install -g grunt-cli
```

Then run the `docs` task.

```
grunt docs
```

now the `docs/index.html` has been updated by the changes you have done in the source.

But don't commit the changes to the html file.

Contributor guide

Open the contributing guide

Research direction

Browse the documentation source for mentions of methods and functions, then identify the appropriate inline-code formatting and documentation links for each. Install grunt-cli with npm, run the docs task, and inspect docs/index.html to verify the generated output; leave that generated HTML file uncommitted.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.