Skip to content

Conversation

@valentinfernandez1
Copy link
Contributor

This PR adds documentation for the api.derives namespace including detailed infortation about each derive and it's usage.

Automatically generated from the polkadot-js/api code documentation.

Copy link
Member

@TarikGul TarikGul left a comment

Choose a reason for hiding this comment

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

Shouldnt we be bumping the version of the api here so it can have the new script for api derive generation?

@valentinfernandez1
Copy link
Contributor Author

True, in this case I just brought the latest version on master using yarn polkadot-dev-copy-to docs . But that is a cleaner approach.

In that case we would have to wait for the next api release as some changes not yet part of the latest release.

@TarikGul
Copy link
Member

Thats totally fine, lets get this in since it's already part of the 15.7.1 release, and we can hold off on the asset-hub updates until next release.

@TarikGul
Copy link
Member

Interesting, any idea why the build is failing?

@valentinfernandez1
Copy link
Contributor Author

valentinfernandez1 commented Feb 27, 2025

Oh, yes I think I know what is going on. yarn build is running the generation script from typegen, which tries to parse from a local file instead of a dependency.

Since the build happens in the context of the docs it does not have access to the file when running on github actions

@valentinfernandez1
Copy link
Contributor Author

The fix is required on the api side so let's wait for the next release to merge this PRs.

Copy link
Member

@TarikGul TarikGul left a comment

Choose a reason for hiding this comment

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

LGTM

@valentinfernandez1 valentinfernandez1 merged commit 954a86d into master Mar 3, 2025
1 check passed
@valentinfernandez1 valentinfernandez1 deleted the derives-docs branch March 3, 2025 14:13
@polkadot-js-bot
Copy link

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants