imba / imba/imba.io

Documenting javascript functionality

Open
#178 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
83
Forks
36
PR merge metrics
No merged PRs in 30d

Description

Should we include things inherited from javascript like Object and Array methods? The options would be:
- Do not include
- Included one reference to mdn per main topic like [Objects](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)
- list the individual methods, etc deep linking to their corresponding mdn article - [assign](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/assign), .., [keys](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/keys)
- add our own documentation

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the proposed options in this issue for documenting inherited JavaScript Object and Array functionality, including the linked MDN references. Clarify which scope the project wants before changing documentation; done means the selected approach is agreed and documented consistently.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.