repack
repack copied to clipboard
docs: start and bundle commands documentation pages
Summary
Added documentation pages for start and bundle commands
Test plan
[x] tested locally
https://github.com/callstack/repack/assets/7682108/258249cf-1fc4-40e4-b418-c812065c2ad7
⚠️ No Changeset found
Latest commit: ca0272b50d701cd9b2aa3242bcc571896e2a437b
Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.
This PR includes no changesets
When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types
Click here to learn what changesets are, and how to add one.
Click here if you're a maintainer who wants to add a changeset to this PR
The latest updates on your projects. Learn more about Vercel for Git ↗︎
| Name | Status | Preview | Comments | Updated (UTC) |
|---|---|---|---|---|
| repack-website | ✅ Ready (Inspect) | Visit Preview | 💬 Add feedback | Jul 8, 2024 8:43am |
the content looks good! let's just reorganise it slightly - let's combine start and bundle commands into one page named 'repack' that will live alongside of
repack-init.Also, if you want to ensure order of pages, you can add a
_meta.jsonlike inwebsite/src/4.x/docs/code-splitting/_meta.json. The name of doc is kept as a part of URL so let's avoid numbering them 👍
Don't You think this is too much information in one page? Also nesting navigation is not a best practice for UX, we should avoid them if it possible. So I think is better to keep each command separately.
start and bundle are also cli command and the context of usage is explained in the description, so I'm not sure if nesting is necessary in this case.
To highlight 'init' command I;ve order it first, so I think is simple and clear way to show difference between context of particular command.
the content looks good! let's just reorganise it slightly - let's combine start and bundle commands into one page named 'repack' that will live alongside of
repack-init. Also, if you want to ensure order of pages, you can add a_meta.jsonlike inwebsite/src/4.x/docs/code-splitting/_meta.json. The name of doc is kept as a part of URL so let's avoid numbering them 👍Don't You think this is too much information in one page? Also nesting navigation is not a best practice for UX, we should avoid them if it possible. So I think is better to keep each command separately.
startandbundleare also cli command and the context of usage is explained in the description, so I'm not sure if nesting is necessary in this case.To highlight 'init' command I;ve order it first, so I think is simple and clear way to show difference between context of particular command.
hmmm yeah, I wasnt particulary conviced about that as well, WDYT about adding a divider to separate repack-init from the rest? you can do this by adding this, like in website/src/4.x/docs/_meta.json:
{
"type": "divider"
}
@jbroma good idea. It keeps flat navigation and highlights different context. I've pushed changes