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

Test code snippets #236

Open
kapetan3sid opened this issue Dec 10, 2024 · 6 comments
Open

Test code snippets #236

kapetan3sid opened this issue Dec 10, 2024 · 6 comments
Labels
C1 - Medium Medium priority task

Comments

@kapetan3sid
Copy link
Collaborator

Acceptance criteria:

  • Test code snippets before adding them to documentation
@kapetan3sid kapetan3sid added the C1 - Medium Medium priority task label Dec 10, 2024
@kianenigma
Copy link
Contributor

More detail:

atm all the code snippets are project-less files in https://github.com/polkadot-developers/polkadot-docs/tree/master/.snippets

This is not good.

We need:

  1. One massive cargo workspace for all rust code. For polkadot-sdk, we should use polkadot-sdk umbrella crate as it simplifies things alot.
  2. One massive npm workspace for all JS/TS code

Each workspace is pinned to a specific version of polkadot-sdk, polkadot-api, polkadot-js-api, and other major dependencies we have.

These versions should be mentioned in the readme, and somewhere in the docs ("This tutorial is compatible with Polkadot-SDK version x.y.z").

Both of the abobe workspaces should compile and build in the CI.

I'd be happy to mentor someone from Parity to work on this.

@kapetan3sid kapetan3sid assigned 0xLucca and unassigned 0xLucca Dec 19, 2024
@kianenigma
Copy link
Contributor

I'd be happy to mentor someone from Parity to work on this.

Even if not, it is a good task to be shared by @0xLucca and one engineer from Parity.

@kapetan3sid
Copy link
Collaborator Author

@kianenigma, as you mentioned, it would be great for now if the primary assignee for this task came from Parity. Do you have someone in mind for this?

@kianenigma
Copy link
Contributor

Have proposed this to @UtkarshBhardwaj007 to explore, let's see how it goes!

@UtkarshBhardwaj007
Copy link
Collaborator

Acknowledging your message Kian. I am having a look. Also pinged you for some context.

@kianenigma
Copy link
Contributor

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C1 - Medium Medium priority task
Projects
None yet
Development

No branches or pull requests

4 participants