Skip to content

docs: Wording for v2 addon format #1667

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

Merged
merged 2 commits into from
May 2, 2025
Merged

Conversation

MichalBryxi
Copy link
Contributor

  • 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.

@MichalBryxi
Copy link
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

@@ -41,7 +41,7 @@ jobs:
cache: pnpm
- name: Install Dependencies
if: env.SHORT_CIRCUIT == 'false'
run: pnpm install --no-lockfile
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

--no-lockfile? No, just no :)

package.json Outdated
@@ -36,7 +36,7 @@
"@glimmer/component": "^1.1.2",
"@glimmer/syntax": "^0.87.1",
"@glimmer/tracking": "^1.1.2",
"@handlebars/parser": "^2.1.0",
"@handlebars/parser": "^2.2.0",
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Now we can upgrade

.tool-versions Outdated
nodejs 20.19
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure what does .tool-versions do? Local development? But let's keep things in sync.

@@ -23,7 +23,7 @@ jobs:
# Fetch tags pointing to the current commit
TAGS=$(git tag --points-at $GITHUB_SHA)
echo "Tags found: $TAGS"

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My IDE is quite oppinionated :)

@MichalBryxi
Copy link
Contributor Author

Ok I reverted the functional changes here and left the PR only for wording changes.

  1. The functional ones are here: fix: handlebars parser@2.2.0 #1670
  2. This wording PR (and any other) will fail until (1) is merged

@MichalBryxi
Copy link
Contributor Author

@SergeAstapov Ready for discussion / merge

- 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.
@SergeAstapov SergeAstapov merged commit 22ead15 into ember-learn:main May 2, 2025
15 checks passed
@SergeAstapov
Copy link
Collaborator

Thank you @MichalBryxi !

@MichalBryxi MichalBryxi deleted the patch-1 branch May 2, 2025 16:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants