Skip to content

Commit

Permalink
[FIX] - Adding npm install to contributing.md (#256)
Browse files Browse the repository at this point in the history
* fix: adding npm i to contributing guide

* [FIX] - Refactoring testing section (#248)

* fix: testing refactor

* Apply suggestions from code review

Co-authored-by: Erin Shaben <[email protected]>

* fix: references and snippets

* fix: adding cards

* Apply suggestions from code review

Co-authored-by: Dawn Kelly <[email protected]>

* Update develop/parachains/testing/mock-runtime.md

Co-authored-by: Dawn Kelly <[email protected]>

* Tutorials > Interoperability > XCM Transfers (#221)

* fix: add wip

* fix: adding last sections

* fix: wording

* fix: structure

* Apply suggestions from code review

Co-authored-by: 0xLucca <[email protected]>

* fix: adding links

* fix: images structure

* fix: paraphrasing

* fix: paraphrasing

* Update tutorials/interoperability/xcm-transfers/from-relaychain-to-parachain.md

Co-authored-by: Erin Shaben <[email protected]>

* Update tutorials/interoperability/xcm-transfers/from-relaychain-to-parachain.md

Co-authored-by: Erin Shaben <[email protected]>

* fix: table

* fix: adding papi tutorial

* fix: paraphrasing

* fix: moving code to snippet

* fix: snippet

* Update tutorials/interoperability/xcm-transfers/from-relaychain-to-parachain.md

Co-authored-by: 0xLucca <[email protected]>

* Update tutorials/interoperability/xcm-transfers/from-relaychain-to-parachain.md

Co-authored-by: 0xLucca <[email protected]>

* Update tutorials/interoperability/xcm-transfers/from-relaychain-to-parachain.md

Co-authored-by: 0xLucca <[email protected]>

* fix: feedback

* fix: snippet

* fix: link

---------

Co-authored-by: 0xLucca <[email protected]>
Co-authored-by: Erin Shaben <[email protected]>

* [FIX] - Adding references to tutorials (#230)

* fix: adding reference to tutorials on asset hub page

* Add xcm channels

* Add runtime upgrades

* Add chain spec

* Add custom parachains

* fix: adding chopsticks

* fix: zombienet

* Update develop/parachains/get-started/build-custom-parachains.md

Co-authored-by: Nicolás Hussein <[email protected]>

* fix: xcm channels references

* fix: generate chain specs references

* fix: generate chain specs 'where to go next'

* fix: build custom parachains references

* fix: runtime upgrades references

* fix: chopsticks get started references

* fix: zombienet get started references

* fix: asset hub references

* fix: add existing pallets references

* fix: add smart contract funcionality references

* fix: make custom pallet references

* fix: pallet testing references

* fix: generate chain specs references

* fix: adding comment in build custom parachains

* fix: deploy parachain to polkadot references

* fix: setup references

* fix: consensus get started references removed

* fix: architecture parachains references

---------

Co-authored-by: 0xLucca <[email protected]>
Co-authored-by: 0xLucca <[email protected]>

* Tutorials > Polkadot SDK > Parachains > Build Custom Pallet > Build the Pallet (#232)

* wip: build-pallet

* Page ready

* Improvements

* Extract code snippets

* Description and grammarly

* fix: typo

* Add suggestions

* Update tutorials/polkadot-sdk/parachains/build-custom-pallet/build-pallet.md

Co-authored-by: Nicolás Hussein <[email protected]>

* Add root origin reference

* Apply suggestions from code review

Co-authored-by: Erin Shaben <[email protected]>

* Apply fmt

* Apply suggestions from code review

Co-authored-by: Erin Shaben <[email protected]>

* Apply suggestions from code review

Co-authored-by: Nicolás Hussein <[email protected]>

* Apply fixes

---------

Co-authored-by: nhussein11 <[email protected]>
Co-authored-by: Nicolás Hussein <[email protected]>
Co-authored-by: Erin Shaben <[email protected]>

* fix: hidding polkaVM instances and adding informational banner (#251)

* Restructure Get Started section (#246)

* Remove get-started section

* Remove build and deploy pages

* Apply suggestions from code review

Co-authored-by: Erin Shaben <[email protected]>

---------

Co-authored-by: Erin Shaben <[email protected]>

* Tutorials > Polkadot SDK > Parachains > Build Custom Pallet > Pallet Unit Testing (#233)

* fix: wip

* fix: adding snippets

* fix: typo

* Apply suggestions from code review

Co-authored-by: 0xLucca <[email protected]>

* fix: updating mock runtime\

* fix: snippets comments

* fix: typo

* fix: closing expandable elements

* fix: overflow

* fix: overflow

* Update tutorials/polkadot-sdk/parachains/build-custom-pallet/pallet-unit-testing.md

Co-authored-by: Erin Shaben <[email protected]>

* fix: feedback

* fix: clean up the add tutorial branch

* Update tutorials/polkadot-sdk/parachains/build-custom-pallet/pallet-unit-testing.md

Co-authored-by: Erin Shaben <[email protected]>

---------

Co-authored-by: 0xLucca <[email protected]>
Co-authored-by: Erin Shaben <[email protected]>

* fix: feedback applied on mock runtime desc

* fix: adding further resources

* Update develop/parachains/testing/mock-runtime.md

Co-authored-by: Kian Paimani <[email protected]>

* fix: glossary runtime reference

* fix: paraphrasing according to feedback

* fix: paraphrasing

* corrects "benchmark testing" to "benchmarking" throughout the page

* Apply suggestions from code review

Co-authored-by: Dawn Kelly <[email protected]>

* Update develop/parachains/testing/benchmarking.md

Co-authored-by: Dawn Kelly <[email protected]>

* Update develop/parachains/testing/pallet-testing.md

Co-authored-by: Dawn Kelly <[email protected]>

* Update develop/parachains/testing/pallet-testing.md

Co-authored-by: Dawn Kelly <[email protected]>

* Update develop/parachains/testing/pallet-testing.md

Co-authored-by: Dawn Kelly <[email protected]>

* fix: adding reference to polkadot sdk guide

* fix: curly aphostrophes

* Update develop/parachains/testing/mock-runtime.md

Co-authored-by: Dawn Kelly <[email protected]>

* Update develop/parachains/testing/mock-runtime.md

Co-authored-by: Dawn Kelly <[email protected]>

* fix: feedback

* fix: feedback

---------

Co-authored-by: Erin Shaben <[email protected]>
Co-authored-by: Dawn Kelly <[email protected]>
Co-authored-by: 0xLucca <[email protected]>
Co-authored-by: 0xLucca <[email protected]>
Co-authored-by: Kian Paimani <[email protected]>
Co-authored-by: DAWN KELLY <[email protected]>

* fix: typo (#258)

* Obtain Coretime Tutorial (#250)

* Coretime tutorial (most things)

* grammarly

* change to webp

* Apply suggestions from code review

Co-authored-by: Nicolás Hussein <[email protected]>

* paseo imgs

* ondemand updates

* update

* Update tutorials/polkadot-sdk/parachains/obtain-coretime.md

Co-authored-by: Erin Shaben <[email protected]>

* Update tutorials/polkadot-sdk/parachains/obtain-coretime.md

Co-authored-by: Erin Shaben <[email protected]>

* Update tutorials/polkadot-sdk/parachains/obtain-coretime.md

Co-authored-by: Erin Shaben <[email protected]>

* Update tutorials/polkadot-sdk/parachains/obtain-coretime.md

Co-authored-by: Erin Shaben <[email protected]>

* Update tutorials/polkadot-sdk/parachains/obtain-coretime.md

Co-authored-by: Erin Shaben <[email protected]>

* Update tutorials/polkadot-sdk/parachains/obtain-coretime.md

Co-authored-by: Erin Shaben <[email protected]>

* Update tutorials/polkadot-sdk/parachains/obtain-coretime.md

Co-authored-by: Erin Shaben <[email protected]>

* Update tutorials/polkadot-sdk/parachains/obtain-coretime.md

Co-authored-by: Erin Shaben <[email protected]>

* Update tutorials/polkadot-sdk/parachains/obtain-coretime.md

Co-authored-by: Erin Shaben <[email protected]>

* Update tutorials/polkadot-sdk/parachains/obtain-coretime.md

Co-authored-by: Erin Shaben <[email protected]>

* Update tutorials/polkadot-sdk/parachains/obtain-coretime.md

Co-authored-by: Erin Shaben <[email protected]>

* Update tutorials/polkadot-sdk/parachains/obtain-coretime.md

Co-authored-by: Erin Shaben <[email protected]>

* Update tutorials/polkadot-sdk/parachains/obtain-coretime.md

Co-authored-by: Erin Shaben <[email protected]>

* Update tutorials/polkadot-sdk/parachains/obtain-coretime.md

Co-authored-by: Erin Shaben <[email protected]>

* Update tutorials/polkadot-sdk/parachains/obtain-coretime.md

Co-authored-by: Erin Shaben <[email protected]>

* Update tutorials/polkadot-sdk/parachains/obtain-coretime.md

Co-authored-by: Erin Shaben <[email protected]>

* Update tutorials/polkadot-sdk/parachains/obtain-coretime.md

Co-authored-by: Erin Shaben <[email protected]>

* fix: note

* fix: removing note

* fix: removing fake reference

---------

Co-authored-by: Nicolás Hussein <[email protected]>
Co-authored-by: Erin Shaben <[email protected]>
Co-authored-by: nhussein11 <[email protected]>

* add pages for legal policies and info (#255)

* add pages for legal policies and info

* pull in legal docs from mkdocs

* Apply suggestions from code review

Co-authored-by: albertov19 <[email protected]>

---------

Co-authored-by: 0xLucca <[email protected]>
Co-authored-by: albertov19 <[email protected]>

* fix: replace old links (#260)

* add script to fix created dates (#259)

* Merge dev-pathways into develop/index (#249)

* removes "crosschain" as a dev pathway from develop/index.md

* save point before adding grid elements

* merges dev-pathways content into dev index page, updates incorrect link to Nova wallet, removes dev-pathways and updates nav

* updates Pathway name to use Application Developers consistently on this page

* adds some info to parachains/index

* update card format on develop/index, adds tip re: smart contracts are in active dev to develop/smart-contracts/index

* update language describing dev paths on develop/toolkit/index for consistency with rest of section

* typo fix

* Apply suggestions from code review

Co-authored-by: Erin Shaben <[email protected]>

---------

Co-authored-by: Erin Shaben <[email protected]>

* Zero to Hero Tutorial (#254)

* Init structure

* wip: set-up-a-template

* Finish set up a template

* [FIX] - Adding references to tutorials (#230)

* fix: adding reference to tutorials on asset hub page

* Add xcm channels

* Add runtime upgrades

* Add chain spec

* Add custom parachains

* fix: adding chopsticks

* fix: zombienet

* Update develop/parachains/get-started/build-custom-parachains.md

Co-authored-by: Nicolás Hussein <[email protected]>

* fix: xcm channels references

* fix: generate chain specs references

* fix: generate chain specs 'where to go next'

* fix: build custom parachains references

* fix: runtime upgrades references

* fix: chopsticks get started references

* fix: zombienet get started references

* fix: asset hub references

* fix: add existing pallets references

* fix: add smart contract funcionality references

* fix: make custom pallet references

* fix: pallet testing references

* fix: generate chain specs references

* fix: adding comment in build custom parachains

* fix: deploy parachain to polkadot references

* fix: setup references

* fix: consensus get started references removed

* fix: architecture parachains references

---------

Co-authored-by: 0xLucca <[email protected]>
Co-authored-by: 0xLucca <[email protected]>

* Tutorials > Polkadot SDK > Parachains > Build Custom Pallet > Build the Pallet (#232)

* wip: build-pallet

* Page ready

* Improvements

* Extract code snippets

* Description and grammarly

* fix: typo

* Add suggestions

* Update tutorials/polkadot-sdk/parachains/build-custom-pallet/build-pallet.md

Co-authored-by: Nicolás Hussein <[email protected]>

* Add root origin reference

* Apply suggestions from code review

Co-authored-by: Erin Shaben <[email protected]>

* Apply fmt

* Apply suggestions from code review

Co-authored-by: Erin Shaben <[email protected]>

* Apply suggestions from code review

Co-authored-by: Nicolás Hussein <[email protected]>

* Apply fixes

---------

Co-authored-by: nhussein11 <[email protected]>
Co-authored-by: Nicolás Hussein <[email protected]>
Co-authored-by: Erin Shaben <[email protected]>

* fix: index zero to hero

* fix: clean up .pages

* fix: set up template where to go next

* fix: adding build a custom pallet content and moving code snippets

* Fix build pallet page

* wip: Add pallets to the runtime

* fix: wip

* fix: clean up pallet unit testing

* fix: pre-commit whitelisted files

* Finish add pallet to runtime

* Improve story telling

* wip: Execute Runtime Upgrades

* wip: deploy to testnet

* Deploy to Testnet ready

* Apply suggestions from code review

Co-authored-by: Dawn Kelly <[email protected]>

* Update develop/parachains/maintenance/runtime-upgrades.md

Co-authored-by: Dawn Kelly <[email protected]>

* Update tutorials/polkadot-sdk/parachains/zero-to-hero/add-pallets-to-runtime.md

Co-authored-by: Dawn Kelly <[email protected]>

* fix: adding tip to zero to hero index page

* [FIX] - Refactoring testing section (#248)

* fix: testing refactor

* Apply suggestions from code review

Co-authored-by: Erin Shaben <[email protected]>

* fix: references and snippets

* fix: adding cards

* Apply suggestions from code review

Co-authored-by: Dawn Kelly <[email protected]>

* Update develop/parachains/testing/mock-runtime.md

Co-authored-by: Dawn Kelly <[email protected]>

* Tutorials > Interoperability > XCM Transfers (#221)

* fix: add wip

* fix: adding last sections

* fix: wording

* fix: structure

* Apply suggestions from code review

Co-authored-by: 0xLucca <[email protected]>

* fix: adding links

* fix: images structure

* fix: paraphrasing

* fix: paraphrasing

* Update tutorials/interoperability/xcm-transfers/from-relaychain-to-parachain.md

Co-authored-by: Erin Shaben <[email protected]>

* Update tutorials/interoperability/xcm-transfers/from-relaychain-to-parachain.md

Co-authored-by: Erin Shaben <[email protected]>

* fix: table

* fix: adding papi tutorial

* fix: paraphrasing

* fix: moving code to snippet

* fix: snippet

* Update tutorials/interoperability/xcm-transfers/from-relaychain-to-parachain.md

Co-authored-by: 0xLucca <[email protected]>

* Update tutorials/interoperability/xcm-transfers/from-relaychain-to-parachain.md

Co-authored-by: 0xLucca <[email protected]>

* Update tutorials/interoperability/xcm-transfers/from-relaychain-to-parachain.md

Co-authored-by: 0xLucca <[email protected]>

* fix: feedback

* fix: snippet

* fix: link

---------

Co-authored-by: 0xLucca <[email protected]>
Co-authored-by: Erin Shaben <[email protected]>

* [FIX] - Adding references to tutorials (#230)

* fix: adding reference to tutorials on asset hub page

* Add xcm channels

* Add runtime upgrades

* Add chain spec

* Add custom parachains

* fix: adding chopsticks

* fix: zombienet

* Update develop/parachains/get-started/build-custom-parachains.md

Co-authored-by: Nicolás Hussein <[email protected]>

* fix: xcm channels references

* fix: generate chain specs references

* fix: generate chain specs 'where to go next'

* fix: build custom parachains references

* fix: runtime upgrades references

* fix: chopsticks get started references

* fix: zombienet get started references

* fix: asset hub references

* fix: add existing pallets references

* fix: add smart contract funcionality references

* fix: make custom pallet references

* fix: pallet testing references

* fix: generate chain specs references

* fix: adding comment in build custom parachains

* fix: deploy parachain to polkadot references

* fix: setup references

* fix: consensus get started references removed

* fix: architecture parachains references

---------

Co-authored-by: 0xLucca <[email protected]>
Co-authored-by: 0xLucca <[email protected]>

* Tutorials > Polkadot SDK > Parachains > Build Custom Pallet > Build the Pallet (#232)

* wip: build-pallet

* Page ready

* Improvements

* Extract code snippets

* Description and grammarly

* fix: typo

* Add suggestions

* Update tutorials/polkadot-sdk/parachains/build-custom-pallet/build-pallet.md

Co-authored-by: Nicolás Hussein <[email protected]>

* Add root origin reference

* Apply suggestions from code review

Co-authored-by: Erin Shaben <[email protected]>

* Apply fmt

* Apply suggestions from code review

Co-authored-by: Erin Shaben <[email protected]>

* Apply suggestions from code review

Co-authored-by: Nicolás Hussein <[email protected]>

* Apply fixes

---------

Co-authored-by: nhussein11 <[email protected]>
Co-authored-by: Nicolás Hussein <[email protected]>
Co-authored-by: Erin Shaben <[email protected]>

* fix: hidding polkaVM instances and adding informational banner (#251)

* Restructure Get Started section (#246)

* Remove get-started section

* Remove build and deploy pages

* Apply suggestions from code review

Co-authored-by: Erin Shaben <[email protected]>

---------

Co-authored-by: Erin Shaben <[email protected]>

* Tutorials > Polkadot SDK > Parachains > Build Custom Pallet > Pallet Unit Testing (#233)

* fix: wip

* fix: adding snippets

* fix: typo

* Apply suggestions from code review

Co-authored-by: 0xLucca <[email protected]>

* fix: updating mock runtime\

* fix: snippets comments

* fix: typo

* fix: closing expandable elements

* fix: overflow

* fix: overflow

* Update tutorials/polkadot-sdk/parachains/build-custom-pallet/pallet-unit-testing.md

Co-authored-by: Erin Shaben <[email protected]>

* fix: feedback

* fix: clean up the add tutorial branch

* Update tutorials/polkadot-sdk/parachains/build-custom-pallet/pallet-unit-testing.md

Co-authored-by: Erin Shaben <[email protected]>

---------

Co-authored-by: 0xLucca <[email protected]>
Co-authored-by: Erin Shaben <[email protected]>

* fix: feedback applied on mock runtime desc

* fix: adding further resources

* Update develop/parachains/testing/mock-runtime.md

Co-authored-by: Kian Paimani <[email protected]>

* fix: glossary runtime reference

* fix: paraphrasing according to feedback

* fix: paraphrasing

* corrects "benchmark testing" to "benchmarking" throughout the page

* Apply suggestions from code review

Co-authored-by: Dawn Kelly <[email protected]>

* Update develop/parachains/testing/benchmarking.md

Co-authored-by: Dawn Kelly <[email protected]>

* Update develop/parachains/testing/pallet-testing.md

Co-authored-by: Dawn Kelly <[email protected]>

* Update develop/parachains/testing/pallet-testing.md

Co-authored-by: Dawn Kelly <[email protected]>

* Update develop/parachains/testing/pallet-testing.md

Co-authored-by: Dawn Kelly <[email protected]>

* fix: adding reference to polkadot sdk guide

* fix: curly aphostrophes

* Update develop/parachains/testing/mock-runtime.md

Co-authored-by: Dawn Kelly <[email protected]>

* Update develop/parachains/testing/mock-runtime.md

Co-authored-by: Dawn Kelly <[email protected]>

* fix: feedback

* fix: feedback

---------

Co-authored-by: Erin Shaben <[email protected]>
Co-authored-by: Dawn Kelly <[email protected]>
Co-authored-by: 0xLucca <[email protected]>
Co-authored-by: 0xLucca <[email protected]>
Co-authored-by: Kian Paimani <[email protected]>
Co-authored-by: DAWN KELLY <[email protected]>

* fix: typo (#258)

* Obtain Coretime Tutorial (#250)

* Coretime tutorial (most things)

* grammarly

* change to webp

* Apply suggestions from code review

Co-authored-by: Nicolás Hussein <[email protected]>

* paseo imgs

* ondemand updates

* update

* Update tutorials/polkadot-sdk/parachains/obtain-coretime.md

Co-authored-by: Erin Shaben <[email protected]>

* Update tutorials/polkadot-sdk/parachains/obtain-coretime.md

Co-authored-by: Erin Shaben <[email protected]>

* Update tutorials/polkadot-sdk/parachains/obtain-coretime.md

Co-authored-by: Erin Shaben <[email protected]>

* Update tutorials/polkadot-sdk/parachains/obtain-coretime.md

Co-authored-by: Erin Shaben <[email protected]>

* Update tutorials/polkadot-sdk/parachains/obtain-coretime.md

Co-authored-by: Erin Shaben <[email protected]>

* Update tutorials/polkadot-sdk/parachains/obtain-coretime.md

Co-authored-by: Erin Shaben <[email protected]>

* Update tutorials/polkadot-sdk/parachains/obtain-coretime.md

Co-authored-by: Erin Shaben <[email protected]>

* Update tutorials/polkadot-sdk/parachains/obtain-coretime.md

Co-authored-by: Erin Shaben <[email protected]>

* Update tutorials/polkadot-sdk/parachains/obtain-coretime.md

Co-authored-by: Erin Shaben <[email protected]>

* Update tutorials/polkadot-sdk/parachains/obtain-coretime.md

Co-authored-by: Erin Shaben <[email protected]>

* Update tutorials/polkadot-sdk/parachains/obtain-coretime.md

Co-authored-by: Erin Shaben <[email protected]>

* Update tutorials/polkadot-sdk/parachains/obtain-coretime.md

Co-authored-by: Erin Shaben <[email protected]>

* Update tutorials/polkadot-sdk/parachains/obtain-coretime.md

Co-authored-by: Erin Shaben <[email protected]>

* Update tutorials/polkadot-sdk/parachains/obtain-coretime.md

Co-authored-by: Erin Shaben <[email protected]>

* Update tutorials/polkadot-sdk/parachains/obtain-coretime.md

Co-authored-by: Erin Shaben <[email protected]>

* Update tutorials/polkadot-sdk/parachains/obtain-coretime.md

Co-authored-by: Erin Shaben <[email protected]>

* Update tutorials/polkadot-sdk/parachains/obtain-coretime.md

Co-authored-by: Erin Shaben <[email protected]>

* fix: note

* fix: removing note

* fix: removing fake reference

---------

Co-authored-by: Nicolás Hussein <[email protected]>
Co-authored-by: Erin Shaben <[email protected]>
Co-authored-by: nhussein11 <[email protected]>

* fix: updating coretime page, images and snippet according to the zero-to-hero structure

* fix: coretime desc

* fix: todos

* fix: where to go next

* updates to some index pages

* fix: where to go next (2)

* Remove old content

* Apply suggestions from code review

Co-authored-by: Erin Shaben <[email protected]>

* Remove execute-runtime-upgrade tutorial

* fix: adding links to prev tutorials

* fix: adding reference to utility pallet

* Update index file

* fix: adding link to zero to hero index

* Update build pallet name

* fix: polkadot sdk tutorials index

* Comment where to go next section in develop

* Update develop/parachains/maintenance/runtime-upgrades.md

Co-authored-by: Erin Shaben <[email protected]>

* fix: CTAs

* fix: CTAs titles to generic "Get Started"

* Update tutorials section index file

* fix: card style

* removes coming soon content, adds Where to Go Next to Install Polkadot SDK page to link to Zero to Hero section

* few updates to links

* update prereq copy on set up a template

* updates link

* update link text

---------

Co-authored-by: Nicolás Hussein <[email protected]>
Co-authored-by: nhussein11 <[email protected]>
Co-authored-by: Erin Shaben <[email protected]>
Co-authored-by: Dawn Kelly <[email protected]>
Co-authored-by: Kian Paimani <[email protected]>
Co-authored-by: DAWN KELLY <[email protected]>
Co-authored-by: bader y <[email protected]>

* fix: broken link (#261)

* fix: typo (#262)

* update broken links (#263)

* trigger build (#264)

* update layout of develop index page (#265)

* update layout

* switch to lists

* Tutorials > On-Chain Governance > How to Fast Track a Governance Proposal (#223)

* wip: fast track prop

* Add snippets and improve structure

* Apply suggestions from code review

Co-authored-by: Radha <[email protected]>

* Apply suggestions from code review

Co-authored-by: Nicolás Hussein <[email protected]>

* Add improvements

* Add description

* Add comments

* Apply suggestions from code review

Co-authored-by: Nicolás Hussein <[email protected]>

* Apply suggestions from code review

Co-authored-by: Erin Shaben <[email protected]>

* Apply suggestions

* Fix preimage explanation

* Remove bold

* Improve main function

* Refactor connectToFork

* Refactor

* Apply suggestions from code review

Co-authored-by: Dawn Kelly <[email protected]>

* Improve generateProposal section

* Refactor forceProposalExecution

* Improve grammar

* Update tutorials/onchain-governance/fast-track-gov-proposal.md

* quick update to index page

* Update polkadot-protocol/glossary.md

Co-authored-by: Nicolás Hussein <[email protected]>

---------

Co-authored-by: Radha <[email protected]>
Co-authored-by: Nicolás Hussein <[email protected]>
Co-authored-by: Erin Shaben <[email protected]>
Co-authored-by: Dawn Kelly <[email protected]>

* Add link to best practices (#266)

* fix double slashes (#279)

* Create mermaid diagram for Substrate Node (#267)

* adds mermaid diagram for Substrate Node

* apply feedback from review

* fix: mermaid styles :)

---------

Co-authored-by: nhussein11 <[email protected]>

* fix a step in set-up-a-template (#285)

* fix a step in set-up-a-template

* Update tutorials/polkadot-sdk/parachains/zero-to-hero/set-up-a-template.md

Co-authored-by: bader y <[email protected]>

---------

Co-authored-by: bader y <[email protected]>

* create a rust workspace for code snippets and migrate 'build-a-custom-pallet' to it (#287)

* create a rust workspace for code snippets and migrate 'build-a-custom-pallet' to it

* Update homepage information in Cargo workspace.

Co-authored-by: Kian Paimani <[email protected]>

* add W3F and papermoon as authors

* minor formatting

Co-authored-by: Kian Paimani <[email protected]>

* update comment

Co-authored-by: Kian Paimani <[email protected]>

---------

Co-authored-by: Kian Paimani <[email protected]>

* Minor fix: Moved to inline from being copyable (#283)

Problem: Websocket address was presented like it should be copied (which implied it needs to be pasted, which leads down a rabbit hole...). Instead moved it to inline, so that the instruction is clearly to open Polkadot app

* update all index to show feedback (#294)

* Create mermaid diagram for Coretime (#268)

* adds mermaid diagram to describe coretime

* Apply suggestions from code review

Co-authored-by: Nicolás Hussein <[email protected]>

---------

Co-authored-by: Nicolás Hussein <[email protected]>

* fix: wording

* fix: prettier

---------

Co-authored-by: Erin Shaben <[email protected]>
Co-authored-by: Dawn Kelly <[email protected]>
Co-authored-by: 0xLucca <[email protected]>
Co-authored-by: 0xLucca <[email protected]>
Co-authored-by: Kian Paimani <[email protected]>
Co-authored-by: DAWN KELLY <[email protected]>
Co-authored-by: bader y <[email protected]>
Co-authored-by: albertov19 <[email protected]>
Co-authored-by: Radha <[email protected]>
Co-authored-by: Utkarsh Bhardwaj <[email protected]>
Co-authored-by: Jan-Jan <[email protected]>
Co-authored-by: Lucas Malizia <[email protected]>
  • Loading branch information
13 people authored Jan 10, 2025
1 parent 8a81681 commit ded6daf
Showing 1 changed file with 22 additions and 14 deletions.
36 changes: 22 additions & 14 deletions .CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,21 @@ This guide covers how to contribute to the documentation, including serving a lo

## Contents

- [Viewing Site Locally](#view-site-locally)
- [Clone Repositories](#clone-repositories)
- [Install Dependencies and Serve Site](#install-dependencies)
- [Adding New Pages](#adding-new-pages)
- [Creating a Subdirectory](#creating-a-subdirectory)
- [Example `.pages` File](#example-pages-file)
- [Example `index.md` File](#example-indexmd-file)
- [Adding Pages to Existing Subdirectory](#adding-pages-to-existing-subdirectory)
- [Modifying Existing Pages](#modifying-existing-pages)
- [Adding Code and Text Snippets](#adding-code-and-text-snippets)
- [Adding Images](#adding-images)
- [Optimizing for SEO](#search-enging-optimization-seo)
- [Tools for Editing](#tools-for-editing)
- [Contribute to the Polkadot Developer Docs](#contribute-to-the-polkadot-developer-docs)
- [Contents](#contents)
- [Viewing Site Locally](#viewing-site-locally)
- [Clone Repositories](#clone-repositories)
- [Install Dependencies and Serve Site](#install-dependencies-and-serve-site)
- [Adding New Pages](#adding-new-pages)
- [Creating a New Section](#creating-a-new-section)
- [Example `.pages` File](#example-pages-file)
- [Example `index.md` File](#example-indexmd-file)
- [Adding Pages to Existing Section](#adding-pages-to-existing-section)
- [Modifying Existing Pages](#modifying-existing-pages)
- [Adding Code and Text Snippets](#adding-code-and-text-snippets)
- [Adding Images](#adding-images)
- [Search Engine Optimization (SEO)](#search-engine-optimization-seo)
- [Tools for Editing](#tools-for-editing)

## Viewing Site Locally

Expand Down Expand Up @@ -66,7 +68,13 @@ To set up the structure, follow these steps:

This command will install all dependencies listed in the `requirements.txt` file.

2. In the `polkadot-mkdocs` folder (which should be the current one), you can build the site by running:
2. Switch to the polkadot-docs directory and use [npm](https://docs.npmjs.com/about-npm) to install dependencies:

```bash
cd polkadot-docs && npm install
```

3. Navigate back to the `polkadot-mkdocs` folder, then build the site:

```bash
mkdocs serve
Expand Down

0 comments on commit ded6daf

Please sign in to comment.