docs(readme): state what components do and split shipped from planned - #661
Closed
MRmarioruci wants to merge 1 commit into
Closed
docs(readme): state what components do and split shipped from planned#661MRmarioruci wants to merge 1 commit into
MRmarioruci wants to merge 1 commit into
Conversation
State what each component does instead of what it is responsible for. The Control Panel deploys stations and stores the wasms they upgrade to, the Station holds assets and enforces approval policies, the Upgrader installs Station wasms and restores a Station when an upgrade fails. Separate what ships from what is planned: the Target Architecture section listed the CDK, SDK and extensions marketplace alongside shipped components, and multi-chain support read as current. Two corrections. orbit.global is the landing page and the wallet runs at app.orbit.global, but both the intro link and the applications section pointed at orbit.global for the app. The tests badge linked to ./actions/workflows/tests.yaml, which resolves inside the repo tree and 404s.
|
✅ No security or compliance issues detected. Reviewed everything up to 89c3a80. Security Overview
Detected Code Changes
|
Contributor
Author
|
Wrong file, this was meant for RELEASE.md. Closing. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Rewrites
README.mdin direct language: say what each component does rather than what it is responsible for, and separate what ships from what is planned.The component list now names the actual behavior. The Control Panel deploys a Station on request, stores the Station and Upgrader wasms that stations upgrade to, and lists the stations a user belongs to. The Station holds the assets, users, permissions and approval policies, and carries out an operation only once that operation's policy is satisfied. The Upgrader is paired one-to-one with a Station, installs new Station wasms, and can restore the Station when an upgrade fails. Previously three of the four bullets said "is responsible for" or "facilitates common operations" without saying which.
The Target Architecture section listed the CDK, SDK and extensions marketplace in the same breath as shipped components, with the distinction left to the diagram's highlighting. It now says which boxes ship today and which are planned. Multi-chain support likewise read as current and is now marked as not built yet.
Two factual corrections.
orbit.globalis the landing page and the wallet runs atapp.orbit.global, but the intro link and the applications section both pointed atorbit.globalfor the app. And the tests badge linked to./actions/workflows/tests.yaml, which GitHub resolves inside the repo tree and 404s.Unrelated to the release workflow stack (#655 through #658), so it is branched off
mainand can merge independently. No content was removed except one closing line that repeated the point above it, and the diagrams, commands, badges and links are otherwise untouched.