Skip to content
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.

Sign up for GitHub

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

Jump to bottom

docs(explorer): update README #3088

Closed
wants to merge 1 commit into from
Closed

docs(explorer): update README #3088

wants to merge 1 commit into from

Conversation

karooolis
Copy link
Contributor

No description provided.

@changeset-bot changeset-bot
Copy link

changeset-bot bot commented Aug 29, 2024

⚠️ No Changeset found

Latest commit: fcf7d61

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

holic
holic reviewed Aug 29, 2024
View reviewed changes
packages/explorer/README.md
@@ -23,7 +23,7 @@ World Explorer is a GUI tool designed for visually exploring and manipulating th
Alternatively, if you have a worlds configuration file:

```sh
npx @latticexyz/explorer --worldsConfigPath <PATH_TO_WORLDS_CONFIG>
npx @latticexyz/explorer --worldsFile <PATH_TO_WORLDS_CONFIG>
```
Copy link
Member

Choose a reason for hiding this comment

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

since this defaults to the location we put the file in, I think we can remove this arg and let folks figure out how to customize the arg

and maybe instead of "if you have a worlds config file" something like "if you've deployed a world from your project"

Copy link
Contributor Author

@karooolis karooolis Aug 29, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Closing this PR in favor of @qbzzt #3074 , let's take the discussion there, it includes an updated README.

@karooolis
Copy link
Contributor Author

Closing in favor of #3074

@karooolis karooolis closed this Aug 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@holic holic holic left review comments

@alvrs alvrs Awaiting requested review from alvrs alvrs will be requested when the pull request is marked ready for review alvrs is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@karooolis @holic