Skip to content

Conversation

@nhussein11
Copy link
Collaborator

Solves #1219

πŸ“ Description

Provide a clear and concise description of your changes.

πŸ” Review Preference

Choose one:

  • βœ… I have time to handle formatting/style feedback myself
  • ⚑ Docs team handles formatting (check "Allow edits from maintainers")

πŸ€– AI-Ready Docs

If content changed, regenerate AI files:

  • βœ… I ran python3 scripts/generate_llms.py
  • ⚑ Docs team will regenerate (check "Allow edits from maintainers")

βœ… Checklist

@nhussein11 nhussein11 self-assigned this Nov 12, 2025
@nhussein11 nhussein11 requested a review from a team as a code owner November 12, 2025 18:41
Copilot AI review requested due to automatic review settings November 12, 2025 18:41
Copilot finished reviewing on behalf of nhussein11 November 12, 2025 18:43
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR fixes the local development node documentation by removing an outdated warning banner and a specific git checkout command. The changes primarily affect the smart contracts local dev node guide and include regenerated AI-generated documentation files.

  • Removed the PolkaVM preview warning banner
  • Removed the git checkout command that pinned to a specific commit
  • Cleaned up formatting by removing an extra blank line

Reviewed Changes

Copilot reviewed 15 out of 15 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
smart-contracts/dev-environments/local-dev-node.md Removed PolkaVM warning banner, removed git checkout command, and cleaned up formatting
llms.txt, llms-full.jsonl Regenerated AI documentation files reflecting the documentation changes
.ai/pages/smart-contracts-dev-environments-local-dev-node.md Updated AI-generated page content
.ai/pages/reference.md Added new Technical Reference Overview content (appears to be separate enhancement)
.ai/site-index.json Updated metadata for the reference page
.ai/categories/*.md Regenerated category files with updated reference page content
Comments suppressed due to low confidence (1)

smart-contracts/dev-environments/local-dev-node.md:26

  • The links in this paragraph still reference {{dependencies.repositories.polkadot_sdk_contracts_node.commit_dev_node}}, which points to a specific commit hash (8e2b6f742a38bb13688e12abacded0aab2dbbb23). This creates an inconsistency: the links point to a specific commit, but the instructions below don't check out that commit. Either update these links to point to master or main branch, or restore the git checkout command to match the linked commit.
The Polkadot SDK repository contains both the [Revive Dev node](https://github.com/paritytech/polkadot-sdk/tree/{{dependencies.repositories.polkadot_sdk_contracts_node.commit_dev_node}}/substrate/frame/revive/dev-node){target=\_blank} implementation and the [ETH-RPC adapter](https://github.com/paritytech/polkadot-sdk/tree/{{dependencies.repositories.polkadot_sdk_contracts_node.commit_dev_node}}/substrate/frame/revive/rpc){target=\_blank} required for Ethereum compatibility. Start by cloning the repository and navigating to the project directory:

πŸ’‘ Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.


```bash
git clone https://github.com/paritytech/polkadot-sdk.git
cd polkadot-sdk
Copy link

Copilot AI Nov 12, 2025

Choose a reason for hiding this comment

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

Removing the git checkout command without pinning to a specific version creates reproducibility issues. Users following this guide will clone the latest main branch, which may contain breaking changes or incompatibilities. Consider either: (1) keeping the checkout command with an updated commit hash, (2) checking out a stable release tag (e.g., git checkout polkadot-stable2409), or (3) documenting which version/branch users should use.

Suggested change
cd polkadot-sdk
cd polkadot-sdk
git checkout polkadot-stable2409

Copilot uses AI. Check for mistakes.
@eshaben
Copy link
Collaborator

eshaben commented Nov 13, 2025

@brunopgalvao if this looks good, pls merge. Thanks!

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.

3 participants