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

Rework documentation on types-support, and typegen #5805

Closed
4 tasks done
TarikGul opened this issue Mar 5, 2024 · 3 comments
Closed
4 tasks done

Rework documentation on types-support, and typegen #5805

TarikGul opened this issue Mar 5, 2024 · 3 comments
Assignees

Comments

@TarikGul
Copy link
Member

TarikGul commented Mar 5, 2024

Currently with the update from the polkadot repo, to polkadot-sdk, and the runtime moving to the fellowship, the current documentation in types-support is out of date. It requires a few extra steps to just get the dev environment working for each chain. It would be more comprehensive and help other maintainers work through the general maintenance process.

It came to mind when I was updating the static metadata to the newest versions. It would be good if we maintain documentation for both the leegacy workflow, and the new workflow required for the type generation.

TODO:

  • Bump Substrate
  • Bump polkadot
  • Bump kusama
  • Rework docs to show legacy, and current workflow
@TarikGul TarikGul self-assigned this Mar 5, 2024
@TarikGul
Copy link
Member Author

TarikGul commented Mar 5, 2024

Reference to current docs that are out of date: https://github.com/polkadot-js/api/blob/master/packages/types-support/src/metadata/README.md

@TarikGul
Copy link
Member Author

TarikGul commented Mar 5, 2024

@polkadot-js-bot
Copy link

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue if you think you have a related problem or query.

@polkadot-js polkadot-js locked as resolved and limited conversation to collaborators Mar 22, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Development

No branches or pull requests

2 participants