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.
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
Guide to creating a New Architecture app from template #3056
Guide to creating a New Architecture app from template #3056
Changes from 20 commits
06a3766
f6aff0d
e7446f2
be2eb18
8754e60
a93abdd
5e9a0d9
a1463d8
77dd04d
7e0ccf0
e98f1b1
86a434c
3854b96
2105e4f
ea370fb
eaa0ee2
7ea7ef0
02a9b4e
f845267
c0a3d43
d5bc865
eea036b
f5e1324
aada4dc
df4c17e
9e06f9d
cbb01bc
1ea529b
File filter
Filter by extension
Conversations
Jump to
There are no files selected for viewing
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I found personally confusing the If specifying a version. What does that mean? Should we push for using a versioned template? Or in case a user wants to use a versioned template, we are suggesting using version 0.68 or later?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The latter, based on the discussion at #3056 (comment)
The intro is also supposed to mention compatibility with 0.68+, so we could just move it to there.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I opted to go with
bundle exec
here because I've seen several places that say that's what to do going forward, but I noticed 1. No setup instructions exist that tell you to runbundle install
, but I did need to do that, and 2. I don't think other places in the docs mention usingbundle exec
instead now.It doesn't seem like a huge deal, if you don't
bundle install
first thebundle exec
failure will tell you to, but wondering if that's maybe something to follow up on later?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's a good call. I have to summon @cortinico about this because I haven't joined the team yet when the decision was taken, so he could have more context on this.
For what concerns the doc, I'd rather stay consistent. It's okay to suggest to use
bundle exec
but, if that's the first time in the guide, I will also add that they should runbundle install
once before.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@cortinico: do we have any
:::
-box to wrap these tips nicely, instead of using quotes?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes we do. I saw you folks already sorted this out, but in case you're wondering how this feature works for the future https://docusaurus.io/docs/markdown-features/admonitions
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To follow-up from my previous comment.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The
:::info
syntax wraps the block in a nicely styled box. There are different alternatives available, but I can't find a reference for them.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh good to know, thanks!