adobe / adobe/helix-website

Documentation correction for aem sidekick

Open
#379 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
45
Forks
59
Avg merge
3d 7h
Merged PRs (30d)
12

Description

Url:- https://www.hlx.live/docs/sidekick

The documentation has the following para:-

- The environments array specifies where the plugin should appear (dev, edit, preview, live, or prod). You can also define **exclude_paths** and **include_paths** arrays to narrow down the plugin’s appearance based on the path.

The correct keys are **excludePaths** and **includePaths**
[git Link](https://github.com/adobe/helix-sidekick-extension/blob/main/docs/config.schema.json#L25)

Please correct the documentation

Contributor guide

Open the contributing guide

Research direction

Open the sidekick documentation at https://www.hlx.live/docs/sidekick and compare the plugin configuration wording with docs/config.schema.json at the linked lines. Correct the two key names in the paragraph, then verify that the documentation uses the schema's naming consistently.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.