adobe / adobe/aem-lib

Release JS doc

Open
#20 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
HTML
Stars
5
Forks
11
Avg merge
9h 50m
Merged PRs (30d)
4

Description

Similar to what we do for the admin api (see [public doc](https://www.hlx.live/docs/admin.html), [source](https://github.com/adobe/helix-website/blob/main/docs/admin.html) and [trigger](https://github.com/adobe/helix-admin/blob/main/package.json#L20)), we need to generate a publicaly accessible JS doc for our aem-lib module.

Contributor guide

Open the contributing guide

Research direction

Compare the existing admin API public documentation at docs/admin.html with its source and the trigger in helix-admin/package.json. Then determine how the aem-lib module should generate and expose its JavaScript documentation; done means a publicly accessible JS doc exists for the module.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.