docs: Wording for v2 addon format #1667
Merged
Conversation
This file contains hidden or 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
SergeAstapov
approved these changes
Apr 13, 2025
Contributor
Author
|
\o/ I do do have a good enough-ish fix by bumping node version & making some minor changes. I bundled it with the markdown change as a proof it fixes the build failure for the markdown. But can separate those two if people wan |
MichalBryxi
commented
Apr 16, 2025
.github/workflows/addon-docs.yml
Outdated
| cache: pnpm | ||
| - name: Install Dependencies | ||
| if: env.SHORT_CIRCUIT == 'false' | ||
| run: pnpm install --no-lockfile |
Contributor
Author
There was a problem hiding this comment.
--no-lockfile? No, just no :)
MichalBryxi
commented
Apr 16, 2025
| "@glimmer/syntax": "^0.87.1", | ||
| "@glimmer/tracking": "^1.1.2", | ||
| "@handlebars/parser": "^2.1.0", | ||
| "@handlebars/parser": "^2.2.0", |
Contributor
Author
There was a problem hiding this comment.
Now we can upgrade
MichalBryxi
commented
Apr 16, 2025
| @@ -1,2 +1,2 @@ | |||
| nodejs 18.20.3 | |||
| pnpm 9.9.0 | |||
| nodejs 20.19 | |||
Contributor
Author
There was a problem hiding this comment.
I'm not sure what does .tool-versions do? Local development? But let's keep things in sync.
MichalBryxi
commented
Apr 16, 2025
.github/workflows/addon-docs.yml
Outdated
| # Fetch tags pointing to the current commit | ||
| TAGS=$(git tag --points-at $GITHUB_SHA) | ||
| echo "Tags found: $TAGS" | ||
Contributor
Author
There was a problem hiding this comment.
My IDE is quite oppinionated :)
Contributor
Author
|
Ok I reverted the functional changes here and left the PR only for wording changes.
|
Contributor
Author
|
@SergeAstapov Ready for discussion / merge |
SergeAstapov
reviewed
May 2, 2025
- Link to v2 addon format documentation. Not everyone understands what is this about. - Generic `documentingAddonAt` of value `addon` is confusing as it _might_ be "standard" ember folder. Bu using `my-awesome-addon` we hint that this is _user_ generated name. - For `addonSrcFolder` use _the default_ value of `src`. If the user just copy-pastes it, it will just work.
Collaborator
|
Thank you @MichalBryxi ! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
documentingAddonAtof valueaddonis confusing as it might be "standard" ember folder. Bu usingmy-awesome-addonwe hint that this is user generated name.addonSrcFolderuse the default value ofsrc. If the user just copy-pastes it, it will just work.