Documentation website links / search / description

Open
#644 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Tech stack
javascript
Domain
documentation, search

Research direction

Start with the Helper class page, its edit link to release/packages/@ember/-internals/glimmer/lib/helper.ts, and the helper-function page and search results linked in the report. Compare the displayed code path, search indexing, and side-menu entries. Done means the relevant links, snippet path, search result, and navigation entry are consistent, though the report may need to be split into separate fixes.

Written by the indexing model from the issue text.

Description

This one will probably need to be broken down to multiple issues. So please bear with me:

Landing on the class Helper page this morning I noticed that although the example uses format-currency helper name, the code block for that helper says only currency.js

Screenshot 2019-10-25 at 09 59 15

So I thought I would help by clicking on the "edit" button and issuing PR directly from Github editor.

But the code block there reads (at line 64): app/helpers/format-currency.js, so now I'm not sure whether:
a) I'm looking at different branch of the github repo. In which case the edit button is wrong to taking me to branch release.
b) The branch release is actually correct for this case, but the component that displays the code snippet has a bug that trims app/helpers/format-currency.js to currency.js?

Right after that I noticed that down below in the code there is a mention about "helper function":

In many cases, the ceremony of a full Helper class is not required.

Never saw that. So I tried to go back to guides page and search for it, but no results:
Screenshot 2019-10-25 at 10 05 23

But the page for helper as function (when I crafter the URL manually) does exist.

So I went to see the respective item in the side menu on that page. The item is not there:

Screenshot 2019-10-25 at 10 08 29

Dominant language
JavaScript
Stars
75
Forks
111
Avg merge
45m
Merged PRs (30d)
1

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.

More from ember-learn/ember-api-docs

All issues in ember-learn/ember-api-docs

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.