Frontmatter changes to support auto-generated index page tables#1689
Open
eshaben wants to merge 4 commits into
Open
Frontmatter changes to support auto-generated index page tables#1689eshaben wants to merge 4 commits into
eshaben wants to merge 4 commits into
Conversation
eshaben
added
B0 - Needs Review
Contributor
There was a problem hiding this comment.
Pull request overview
Adds page-level metadata (notably short_description and some tools frontmatter) across the Chain Interactions, Parachains, and Smart Contracts docs to support auto-generated index tables, and refactors key index pages to use <!-- INDEX TABLE ... --> directives instead of hand-maintained lists/tables.
Changes:
- Added
short_descriptionfrontmatter to many docs pages to provide consistent summaries for navigation/index generation. - Introduced/expanded
toolsfrontmatter on selected Smart Contracts tutorials and dev-environment guides. - Refactored
chain-interactions/index.md,parachains/get-started.md,smart-contracts/get-started.md, andsmart-contracts/cookbook/index.mdto use auto-generated index table directives.
Reviewed changes
Copilot reviewed 73 out of 73 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| smart-contracts/precompiles/xcm.md | Add short_description frontmatter for index/table summaries. |
| smart-contracts/precompiles/system.md | Add short_description frontmatter for index/table summaries. |
| smart-contracts/precompiles/storage.md | Add short_description frontmatter for index/table summaries. |
| smart-contracts/precompiles/eth-native.md | Add short_description frontmatter for index/table summaries. |
| smart-contracts/precompiles/erc20.md | Add short_description frontmatter for index/table summaries. |
| smart-contracts/libraries/web3-py.md | Add short_description frontmatter for index/table summaries. |
| smart-contracts/libraries/web3-js.md | Add short_description frontmatter for index/table summaries. |
| smart-contracts/libraries/wagmi.md | Add short_description frontmatter for index/table summaries. |
| smart-contracts/libraries/viem.md | Add short_description frontmatter for index/table summaries. |
| smart-contracts/libraries/ethers-js.md | Add short_description frontmatter for index/table summaries. |
| smart-contracts/integrations/wallets.md | Add short_description frontmatter for index/table summaries. |
| smart-contracts/get-started.md | Replace static lists with INDEX TABLE directives (plus minor table formatting tweaks). |
| smart-contracts/for-eth-devs/json-rpc-apis.md | Add short_description frontmatter for index/table summaries. |
| smart-contracts/for-eth-devs/gas-model.md | Add short_description frontmatter for index/table summaries. |
| smart-contracts/for-eth-devs/evm-vs-pvm.md | Add short_description frontmatter for index/table summaries. |
| smart-contracts/for-eth-devs/dual-vm-stack.md | Add short_description frontmatter for index/table summaries. |
| smart-contracts/for-eth-devs/contract-deployment.md | Add short_description frontmatter for index/table summaries. |
| smart-contracts/for-eth-devs/blocks-transactions-fees.md | Add short_description frontmatter for index/table summaries. |
| smart-contracts/for-eth-devs/accounts.md | Add short_description frontmatter for index/table summaries. |
| smart-contracts/dev-environments/remix.md | Add short_description and tools frontmatter metadata. |
| smart-contracts/dev-environments/local-dev-node.md | Add short_description and tools frontmatter metadata. |
| smart-contracts/dev-environments/hardhat.md | Add short_description/tools and adjust page_tests indentation. |
| smart-contracts/dev-environments/hardhat-polkadot.md | Add short_description and adjust page_tests indentation. |
| smart-contracts/dev-environments/foundry.md | Add short_description and tools frontmatter metadata. |
| smart-contracts/cookbook/smart-contracts/deploy-nft/nft-remix.md | Add tools frontmatter metadata. |
| smart-contracts/cookbook/smart-contracts/deploy-nft/nft-hardhat.md | Add tools frontmatter metadata. |
| smart-contracts/cookbook/smart-contracts/deploy-erc20/erc20-remix.md | Add tools frontmatter metadata. |
| smart-contracts/cookbook/smart-contracts/deploy-erc20/erc20-hardhat.md | Add tools frontmatter metadata. |
| smart-contracts/cookbook/smart-contracts/deploy-basic/basic-remix.md | Add tools frontmatter metadata. |
| smart-contracts/cookbook/smart-contracts/deploy-basic/basic-hardhat.md | Add tools frontmatter metadata. |
| smart-contracts/cookbook/index.md | Replace generated static content block with INDEX TABLE directive configuration. |
| smart-contracts/cookbook/eth-dapps/uniswap-v2/periphery-v2.md | Add tools frontmatter metadata. |
| smart-contracts/cookbook/eth-dapps/uniswap-v2/core-v2.md | Add tools frontmatter metadata. |
| smart-contracts/cookbook/eth-dapps/uniswap-v2/core-v2-pvm.md | Add tools frontmatter metadata. |
| smart-contracts/cookbook/dapps/zero-to-hero.md | Add tools frontmatter and normalize “viem” casing in text. |
| parachains/testing/run-a-parachain-network.md | Add short_description frontmatter for index/table summaries. |
| parachains/testing/fork-a-parachain.md | Add short_description frontmatter for index/table summaries. |
| parachains/runtime-maintenance/unlock-parachains.md | Add short_description frontmatter for index/table summaries. |
| parachains/runtime-maintenance/storage-migrations.md | Add short_description frontmatter for index/table summaries. |
| parachains/runtime-maintenance/runtime-upgrades.md | Add short_description frontmatter for index/table summaries. |
| parachains/runtime-maintenance/coretime-renewal.md | Add short_description frontmatter for index/table summaries. |
| parachains/launch-a-parachain/set-up-the-parachain-template.md | Add short_description frontmatter for index/table summaries. |
| parachains/launch-a-parachain/obtain-coretime.md | Add short_description frontmatter for index/table summaries. |
| parachains/launch-a-parachain/deploy-to-polkadot.md | Add short_description frontmatter for index/table summaries. |
| parachains/interoperability/channels-with-system-parachains.md | Add short_description frontmatter for index/table summaries. |
| parachains/interoperability/channels-between-parachains.md | Add short_description frontmatter for index/table summaries. |
| parachains/integrations/wallets.md | Add short_description frontmatter for index/table summaries. |
| parachains/integrations/oracles.md | Add short_description frontmatter for index/table summaries. |
| parachains/integrations/indexers.md | Add short_description frontmatter for index/table summaries. |
| parachains/get-started.md | Replace multiple static tables with INDEX TABLE directives. |
| parachains/customize-runtime/pallet-development/pallet-testing.md | Add short_description frontmatter for index/table summaries. |
| parachains/customize-runtime/pallet-development/mock-runtime.md | Add short_description frontmatter for index/table summaries. |
| parachains/customize-runtime/pallet-development/create-a-pallet.md | Add short_description frontmatter for index/table summaries. |
| parachains/customize-runtime/pallet-development/benchmark-pallet.md | Add short_description frontmatter for index/table summaries. |
| parachains/customize-runtime/add-smart-contract-functionality.md | Add short_description frontmatter for index/table summaries. |
| parachains/customize-runtime/add-pallet-instances.md | Add short_description frontmatter for index/table summaries. |
| parachains/customize-runtime/add-existing-pallets.md | Add short_description frontmatter for index/table summaries. |
| chain-interactions/token-operations/register-local-asset.md | Add short_description frontmatter for index/table summaries. |
| chain-interactions/token-operations/register-foreign-asset.md | Add short_description frontmatter for index/table summaries. |
| chain-interactions/token-operations/convert-assets.md | Add short_description frontmatter for index/table summaries. |
| chain-interactions/send-transactions/with-sdks.md | Add short_description frontmatter for index/table summaries. |
| chain-interactions/send-transactions/pay-fees-with-different-tokens.md | Add short_description frontmatter for index/table summaries. |
| chain-interactions/send-transactions/interoperability/transfer-assets-parachains.md | Add short_description frontmatter for index/table summaries. |
| chain-interactions/send-transactions/interoperability/transfer-assets-into-polkadot.md | Add short_description frontmatter for index/table summaries. |
| chain-interactions/send-transactions/interoperability/estimate-xcm-fees.md | Add short_description frontmatter for index/table summaries. |
| chain-interactions/send-transactions/interoperability/debug-and-preview-xcms.md | Add short_description frontmatter for index/table summaries. |
| chain-interactions/send-transactions/calculate-transaction-fees.md | Add short_description frontmatter for index/table summaries. |
| chain-interactions/query-data/runtime-api-calls.md | Add short_description frontmatter for index/table summaries. |
| chain-interactions/query-data/query-sdks.md | Add short_description frontmatter for index/table summaries. |
| chain-interactions/query-data/query-rest.md | Add short_description frontmatter for index/table summaries. |
| chain-interactions/index.md | Replace narrative link lists with INDEX TABLE directives and switch tools list to a markdown table. |
| chain-interactions/accounts/query-accounts.md | Add short_description frontmatter for index/table summaries. |
| chain-interactions/accounts/create-account.md | Add short_description frontmatter for index/table summaries. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
📝 Description
This pull request introduces concise
short_descriptionfields to many of the documentation files in the Chain Interactions and Parachains sections. These short descriptions provide a quick summary of each page’s content, improving navigation and making it easier for users to understand the purpose of each guide at a glance. Additionally, thechain-interactions/index.mdfile is refactored to use auto-generated index tables for better maintainability and consistency.The most important changes are:
Documentation Short Descriptions
short_descriptionfields to guides across accounts, querying, transactions, token operations, and parachain customization topics, summarizing each page’s main purpose. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13] [14] [15] [16] [17] [18] [19]Index Page Refactoring
chain-interactions/index.mdto replace static lists with auto-generated index tables for each major section, improving consistency and ease of maintenance.These changes make the documentation more user-friendly and easier to navigate, especially for new developers exploring different Polkadot features.
Goes with papermoonio/polkadot-mkdocs#272