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

Add Async Backing Parachain Guide to Polkadot SDK docs #4342

Closed
wants to merge 5 commits into from
Closed

Add Async Backing Parachain Guide to Polkadot SDK docs #4342

wants to merge 5 commits into from

Conversation

DrW3RK
Copy link
Contributor

@DrW3RK DrW3RK commented May 1, 2024

Reference Issue: w3f/polkadot-wiki#5835

@DrW3RK
Copy link
Contributor Author

DrW3RK commented May 1, 2024

The Wiki doc https://wiki.polkadot.network/docs/maintain-guides-async-backing uses async backing compatible parachain template as a reference which has been moved to https://github.com/paritytech/polkadot-sdk/tree/master/templates/parachain

Currently, this PR #4295 is working on making the parachain template Async backing compatible.

The content on this Async Backing PR needs to be revisited after the above PR is merged.

Copy link
Contributor

@kianenigma kianenigma left a comment

Choose a reason for hiding this comment

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

But this is still using harcoded code snippets right? the goal of my suggestion of moving it here was to make the code snippets be backed by docify.

UPDATE: I see we are blocked on #4295

@@ -0,0 +1,452 @@
//! # Upgrade Parachain for Asynchronous Backing Compatibility
Copy link
Contributor

Choose a reason for hiding this comment

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

What is the plan here will we make https://wiki.polkadot.network/docs/maintain-guides-async-backing point to here ? Because otherwise we will have to maintain this information in two places.

I don't think at this point we can remove https://wiki.polkadot.network/docs/maintain-guides-async-backing, because it has references in other articles and forum posts and it would be a bad experience if it becomes a broken link.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hey @alexggh That is the plan. We will retain preliminary content on that page and add a prominent link to the Polkadot SDK doc. The Wiki doc link will not be broken.

@DrW3RK
Copy link
Contributor Author

DrW3RK commented May 2, 2024

#4363

@DrW3RK DrW3RK closed this May 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants