sui icon indicating copy to clipboard operation
sui copied to clipboard

[docs] Added documentation for dependency overrides

Open awelc opened this issue 2 years ago • 2 comments
trafficstars

Description

A description of how recently landed (https://github.com/MystenLabs/sui/pull/11181) dependency overrides work.

Please let me know if you need this changes, extended, etc.

I am also not sure if this should be a separate file (as it is intended for now) or if it should be folded into an existing document (e.g., https://github.com/MystenLabs/sui/blob/main/doc/src/build/package-upgrades.md), and if the former is the case, if there is any additional work required to have it properly displayed on the developer portal.

Test Plan

It's just the docs


If your changes are not user-facing and not a breaking change, you can skip the following section. Otherwise, please indicate what changed, and then add to the Release Notes section as highlighted during the release process.

Type of Change (Check all that apply)

  • [x] user-visible impact
  • [ ] breaking change for a client SDKs
  • [ ] breaking change for FNs (FN binary must upgrade)
  • [ ] breaking change for validators or node operators (must upgrade binaries)
  • [ ] breaking change for on-chain data layout
  • [ ] necessitate either a data wipe or data migration

Release notes

awelc avatar Apr 24 '23 14:04 awelc

The latest updates on your projects. Learn more about Vercel for Git ↗︎

4 Ignored Deployments
Name Status Preview Comments Updated (UTC)
explorer ⬜️ Ignored (Inspect) Apr 24, 2023 4:11pm
explorer-storybook ⬜️ Ignored (Inspect) Apr 24, 2023 4:11pm
sui-wallet-kit ⬜️ Ignored (Inspect) Apr 24, 2023 4:11pm
wallet-adapter ⬜️ Ignored (Inspect) Apr 24, 2023 4:11pm

vercel[bot] avatar Apr 24 '23 14:04 vercel[bot]

Thanks @awelc ! I've added a Jira for myself to add this topic to the navigation, too.

I have accepted all the suggested changes but will wait for @amnn's feedback on what may have to be changed or added.

awelc avatar Apr 24 '23 15:04 awelc