-
Notifications
You must be signed in to change notification settings - Fork 430
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Better aligning GitHub docs with archetype docs on Experience League #1117
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
From @davidjgonzalez Co-authored-by: david g. <davidjgonzalez@users.noreply.github.com>
From @davidjgonzalez Co-authored-by: david g. <davidjgonzalez@users.noreply.github.com>
gabrielwalt
approved these changes
Jan 23, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
There is currently a lot of overlap and redundancy in the documentation for the archetype within the readmes of this repository and that on Experience League (https://experienceleague.adobe.com/docs/experience-manager-core-components/using/developing/archetype/overview.html).
This PR and another in the Core Components documentation repo aims to limit the documentation on Experience League to a usage overview and general information about the archetype while all technical details remain in the GitHub readmes.
Related Issue
CQDOC-20146
PR # 262 on the experience-manager-core-components.en corporate repo
Motivation and Context
With this change, updates to the archetype only need to be updated in the readmes, minimizing the possibility of inconsistencies arising in the two documentation sources. It also makes it clearer to the user what is documented where.
How Has This Been Tested?
No. I only made changes to readmes.
Types of changes
Checklist: