docs: Update addon-author-guide.md #1735
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
There is an overlap in concerns between `addon-author-guide.md` and `porting-addons-to-v2.md` After having mixed the two, I felt a need to link to the detailed step-by-step guide `addon-author-guide.md`, since a lot of the addon-author-guide already mentions strategies to on how to convert.
void-mAlex
reviewed
Dec 19, 2023
docs/addon-author-guide.md
Outdated
| @@ -1,6 +1,6 @@ | |||
| # Addon Author Guide | |||
|
|
|||
| This document lays out the recommended best practices for addon authors who want their addons to work in apps built with Embroider. | |||
| This document lays out the recommended best practices for addon authors who want their addons to work in apps built with Embroider. For a step by step guide on how to convert an addon from v1 to v2, see [Guide: Porting an Addon to V2](https://github.com/embroider-build/embroider/blob/main/docs/porting-addons-to-v2.md) | |||
There was a problem hiding this comment.
using a relative link will mean it stays in sync with the version of the repo you're looking at and is generally better when viewing the file locally
There was a problem hiding this comment.
@void-mAlex thanks! good call. changed to relative url now.
|
@void-mAlex is this doc PR accepted? If it can be merged, I will open the counterpart in the Porting Addons To V2, so both documents link to each other. That could be a way to work on the confusion that can exist between having the addon ready to be consumed by Embroider and migrating the addon to v2. |
NullVoxPopuli
approved these changes
Feb 12, 2024
Closed
Closed
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.
There is an overlap in concerns between
addon-author-guide.mdandporting-addons-to-v2.mdAfter having mixed the two, I felt a need to link to the detailed step-by-step guide
addon-author-guide.md, since a lot of the addon-author-guide already mentions strategies to on how to convert.