adobe / adobe/aem-project-archetype

Documentation Missing in Archetype Requirements

Open
#819 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
596
Forks
431
Avg merge
10d 6h
Merged PRs (30d)
1

Description

### Expected Behaviour

The following links:
https://github.com/adobe/aem-project-archetype/tree/aem-project-archetype-31
https://github.com/adobe/aem-project-archetype/tree/aem-project-archetype-30
https://github.com/adobe/aem-project-archetype/tree/aem-project-archetype-29

Describe the requirements for Archetype 29, 30 and 31 respectively.

### Actual Behaviour

The following links:
https://github.com/adobe/aem-project-archetype/tree/aem-project-archetype-31
https://github.com/adobe/aem-project-archetype/tree/aem-project-archetype-30
https://github.com/adobe/aem-project-archetype/tree/aem-project-archetype-29

Only describes the requirements for Archetype 28 even though it is for archetype 29, 30 and 31

Can we update the README to reflect the correct Archetype version.

Contributor guide

Open the contributing guide

Research direction

Open the README files in the Archetype 29, 30, and 31 trees linked in the issue and compare their requirements sections with the Archetype 28 wording. Update each README to describe its correct Archetype version, then verify that the requirements shown for all three links are version-specific.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.