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.

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

docs(config): add multi-namespace support #2993

Merged
merged 8 commits into from
Aug 5, 2024
Merged

Conversation

qbzzt
Copy link
Contributor

@qbzzt qbzzt commented Jul 30, 2024

Closing: #2994

@qbzzt qbzzt requested review from ludns, alvrs and holic as code owners July 30, 2024 18:31
Copy link

changeset-bot bot commented Jul 30, 2024

⚠️ No Changeset found

Latest commit: 7aae34e

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

docs/pages/config.mdx Outdated Show resolved Hide resolved
docs/pages/config.mdx Outdated Show resolved Hide resolved

- `src/namespaces/app/codegen/tables/Tasks.sol` - the generated code for `app__Tasks` table.
- `src/namespaces/app/codegen/index.sol` - a single file that imports all the table definitions of the namespace (in this case, only `Tasks.sol`).
- `src/codegen/world/I*System.sol` - interfaces for all the `System`s.
Copy link
Member

@holic holic Jul 31, 2024

Choose a reason for hiding this comment

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

Suggested change
- `src/codegen/world/I*System.sol` - interfaces for all the `System`s.
- `src/codegen/world/I*System.sol` - interfaces for all the system functions registered in the world.

- The tables in your project in the `tables` object of your configuration.
- The [namespace](/world/namespaces-access-control) that [systems](/world/systems) and tables will be deployed in.
- The tables in your project.
- The [namespace(s)](/world/namespaces-access-control) that [`System`s](/world/systems) and tables will be deployed in.
Copy link
Member

@holic holic Jul 31, 2024

Choose a reason for hiding this comment

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

Suggested change
- The [namespace(s)](/world/namespaces-access-control) that [`System`s](/world/systems) and tables will be deployed in.
- The [namespace(s)](/world/namespaces-access-control) that [systems](/world/systems) and tables will be deployed in.

let's use a regular noun for systems throughout rather than a proper noun or code snippet (to match "tables", etc)

@@ -35,7 +82,7 @@ export default defineWorld({
},
},
systems: {
TestSystem: {
RootSystem: {
Copy link
Member

Choose a reason for hiding this comment

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

can we think of another example? I don't think should promote "root" things

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 changed it. But in general, you often have to have some code with admin powers, and that code needs to be of limited availability.

docs/pages/config.mdx Outdated Show resolved Hide resolved
@holic holic merged commit af4ae94 into main Aug 5, 2024
5 checks passed
@holic holic deleted the 240730-config-multi-namespace branch August 5, 2024 11:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants