-
Notifications
You must be signed in to change notification settings - Fork 74
Update .CONTRIBUTING.md #1199
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
Update .CONTRIBUTING.md #1199
Conversation
There was a problem hiding this 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 modifies the .CONTRIBUTING.md file to remove the HTML language identifier from a code fence in the Termynal command output section. The change removes syntax highlighting for an HTML code block, which impacts documentation readability.
- The code fence language identifier is changed from ````html` to plain `````, removing syntax highlighting for the HTML example
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
dawnkelly09
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🚢
* Include Ubuntu Rust setup commands (#964) * Include Ubuntu Rust setup commands * Using tabs instead of headers to differentiate OS and ran scripts/generate_llms.py * Regenerate llms files * September SEO (#996) * fix url * llms * Update dependencies (#995) * Update hardhat.md (#972) * Update hardhat.md added Node version recommendation in pre-reqs so it's more prominent * LLM updates re: Node version LLM updates re: Node version * Update GPG Key Links to Match Visible Ones (#967) The Security and Release Team links were swapped in the html reference * Overhaul LLMs (docs changes) (#969) * adds script to output .md pages to /.ai/, adds ai_exclude flag to needed pages, adds initial batch of ai files * adds Tutorial tag to relevant pages, updates scripts for generating new llms files (still need category files) * adds category file generation * updates main llms script, removes deprecated LLMs files * adds estimated token count to category bundle outputs * adds variable for base url for ai artifact files * wired up existing UI, updated default file outputs * update f string copy to match file renaming * updates check-llms workflow to verify llms.txt as llms-full.txt is deprecated with these changes * fresh llms * updates urls for prod * update scripts per feedback (remove bundle from file path) * Fix filepaths to remove bundle * remove log line that is no longer needed * patch to remove source repos and optional resources from llms.txt, WIP README * patch script to output llms-full.jsonl to root of docs repo (too big to download via browser like other /.ai/ files) * updates README * tweaking workflow for new full site file use * removes Tutorial category (we can figure out how we want to manage tagging these in future ticket). * updated llms * remove ai_exclude flag and tags, update README * remove blank end lines * update generate category script to only output md format (will explore other formats in future ticket) * updates per feedback, fresh llms * formatting * remove tutorial.md bundle file as not needed at this time. * update to fix errant hyphen in front of code snippets, ran fresh llm files with the corrections in place * remove check for 'ai_exclude' flag * remove ai exclude tag * remove Tutorial tags, fresh llms * updates script to fix formatting issue in output files, fresh llms * update code comment * missed a file save! * improved README * fresh llms * Revert "Overhaul LLMs (docs changes) (#969)" (#1004) This reverts commit 68f574d. * Latest Node recommended, fixed indentation (#1007) * Update hardhat.md added Node version recommendation in pre-reqs so it's more prominent * LLM updates re: Node version LLM updates re: Node version * Update hardhat to recommend Node 22.5 Node 22.5 version required for latest plugin version (released a couple of days ago) to avoid Websocket issues. Also to fix indentation :) * update LLM files with node version for hardhat update LLM files with node version for hardhat * Improve contributor experience with streamlined documentation and workflows (#974) * Improve CONTRIBUTING workflow * Update workflow * Update workflow * Update wording to be clear and concise * Update .CONTRIBUTING.md Co-authored-by: Erin Shaben <eshaben@icloud.com> * Update .CONTRIBUTING.md Co-authored-by: Erin Shaben <eshaben@icloud.com> * Update .CONTRIBUTING.md Co-authored-by: Erin Shaben <eshaben@icloud.com> * Update .CONTRIBUTING.md Co-authored-by: Erin Shaben <eshaben@icloud.com> * Update .CONTRIBUTING.md Co-authored-by: Erin Shaben <eshaben@icloud.com> * Update .CONTRIBUTING.md Co-authored-by: Erin Shaben <eshaben@icloud.com> * Update .CONTRIBUTING.md Co-authored-by: Erin Shaben <eshaben@icloud.com> * Update README.md Co-authored-by: Erin Shaben <eshaben@icloud.com> * Update .CONTRIBUTING.md Co-authored-by: Erin Shaben <eshaben@icloud.com> * Update .CONTRIBUTING.md Co-authored-by: Erin Shaben <eshaben@icloud.com> * Update .CONTRIBUTING.md Co-authored-by: Erin Shaben <eshaben@icloud.com> * Update .CONTRIBUTING.md Co-authored-by: Erin Shaben <eshaben@icloud.com> * Update .CONTRIBUTING.md Co-authored-by: Erin Shaben <eshaben@icloud.com> * Update .CONTRIBUTING.md Co-authored-by: Erin Shaben <eshaben@icloud.com> * Update .CONTRIBUTING.md Co-authored-by: Erin Shaben <eshaben@icloud.com> * Update .CONTRIBUTING.md Co-authored-by: Erin Shaben <eshaben@icloud.com> * Update .CONTRIBUTING.md Co-authored-by: Erin Shaben <eshaben@icloud.com> * Update .CONTRIBUTING.md Co-authored-by: Erin Shaben <eshaben@icloud.com> * Update .CONTRIBUTING.md Co-authored-by: Erin Shaben <eshaben@icloud.com> * Update .CONTRIBUTING.md Co-authored-by: Erin Shaben <eshaben@icloud.com> * Update .CONTRIBUTING.md Co-authored-by: Erin Shaben <eshaben@icloud.com> * Update .CONTRIBUTING.md Co-authored-by: Erin Shaben <eshaben@icloud.com> * Update .CONTRIBUTING.md Co-authored-by: Erin Shaben <eshaben@icloud.com> * Update content * Update .CONTRIBUTING.md Co-authored-by: Erin Shaben <eshaben@icloud.com> * Update .CONTRIBUTING.md Co-authored-by: Erin Shaben <eshaben@icloud.com> * Update .CONTRIBUTING.md Co-authored-by: Erin Shaben <eshaben@icloud.com> * Update .CONTRIBUTING.md Co-authored-by: Erin Shaben <eshaben@icloud.com> * Update .CONTRIBUTING.md Co-authored-by: Erin Shaben <eshaben@icloud.com> * Update .CONTRIBUTING.md Co-authored-by: Erin Shaben <eshaben@icloud.com> * Update README.md Co-authored-by: Erin Shaben <eshaben@icloud.com> * Update README.md Co-authored-by: Erin Shaben <eshaben@icloud.com> * Update README.md Co-authored-by: Erin Shaben <eshaben@icloud.com> * add termynal element * Update content * Update .CONTRIBUTING.md Co-authored-by: Erin Shaben <eshaben@icloud.com> * Update content --------- Co-authored-by: Erin Shaben <eshaben@icloud.com> * Add Polkadart to tooling section (#944) * Add polkadart * Update develop/toolkit/api-libraries/polkadart.md Co-authored-by: Nicolás Hussein <80422357+nhussein11@users.noreply.github.com> * PR feedback * Update develop/toolkit/api-libraries/polkadart.md Co-authored-by: Taylor Lucero <67010424+Telucero@users.noreply.github.com> * Update develop/toolkit/api-libraries/polkadart.md Co-authored-by: Taylor Lucero <67010424+Telucero@users.noreply.github.com> * Update develop/toolkit/api-libraries/polkadart.md Co-authored-by: Taylor Lucero <67010424+Telucero@users.noreply.github.com> * Update develop/toolkit/api-libraries/polkadart.md Co-authored-by: Taylor Lucero <67010424+Telucero@users.noreply.github.com> * Update develop/toolkit/api-libraries/polkadart.md Co-authored-by: Taylor Lucero <67010424+Telucero@users.noreply.github.com> * Update develop/toolkit/api-libraries/polkadart.md Co-authored-by: Taylor Lucero <67010424+Telucero@users.noreply.github.com> * Update .nav.yml --------- Co-authored-by: Nicolás Hussein <80422357+nhussein11@users.noreply.github.com> Co-authored-by: Taylor Lucero <67010424+Telucero@users.noreply.github.com> * Update .nav.yml (#1003) * Update Rust setup instructions in template guide (#1006) * add install command * add llms files * Update validator onboarding images and documentation (#979) * Update validator onboarding images and documentation * fix: typo * fix: llms * docs: Update validator activation instructions in onboarding guide * fix: llms * docs: Update validator activation steps to include bond amount requirement * fix: llms * fix: start validating page * fix: last image * fix: llms * fix * fix: llms * fresh llms * llms check * fresh llms --------- Co-authored-by: DAWN KELLY <dawnkelly09@gmail.com> * Add guide on transferring tokens between parachains (#973) * WIP: Creating ParaSpell transfer guide * WIP * Add ParaSpell transfer guide * Update develop/toolkit/interoperability/paraspell/index.md Co-authored-by: Nicolás Hussein <80422357+nhussein11@users.noreply.github.com> * Update develop/toolkit/interoperability/paraspell/paraspell-xcm-sdk.md Co-authored-by: Nicolás Hussein <80422357+nhussein11@users.noreply.github.com> * Update develop/toolkit/interoperability/paraspell/paraspell-xcm-sdk.md Co-authored-by: Nicolás Hussein <80422357+nhussein11@users.noreply.github.com> * Update develop/toolkit/interoperability/paraspell/paraspell-xcm-sdk.md Co-authored-by: Nicolás Hussein <80422357+nhussein11@users.noreply.github.com> * Update develop/toolkit/interoperability/paraspell/paraspell-xcm-sdk.md Co-authored-by: Nicolás Hussein <80422357+nhussein11@users.noreply.github.com> * Update content * Update content * Update develop/toolkit/interoperability/paraspell-xcm-sdk/teleport-from-asset-hub-to-relay-chain.md Co-authored-by: Taylor Lucero <67010424+Telucero@users.noreply.github.com> * Update develop/toolkit/interoperability/paraspell-xcm-sdk/teleport-from-asset-hub-to-relay-chain.md Co-authored-by: Taylor Lucero <67010424+Telucero@users.noreply.github.com> * Update develop/toolkit/interoperability/paraspell-xcm-sdk/teleport-from-asset-hub-to-relay-chain.md Co-authored-by: Taylor Lucero <67010424+Telucero@users.noreply.github.com> * Update develop/toolkit/interoperability/paraspell-xcm-sdk/teleport-from-asset-hub-to-relay-chain.md Co-authored-by: Taylor Lucero <67010424+Telucero@users.noreply.github.com> * Update develop/toolkit/interoperability/paraspell-xcm-sdk/teleport-from-asset-hub-to-relay-chain.md Co-authored-by: Taylor Lucero <67010424+Telucero@users.noreply.github.com> * Update develop/toolkit/interoperability/paraspell-xcm-sdk/index.md Co-authored-by: Taylor Lucero <67010424+Telucero@users.noreply.github.com> * Update content * Update content * Update develop/toolkit/interoperability/paraspell-xcm-sdk/teleport-from-asset-hub-to-bridge-hub.md Co-authored-by: Nicolás Hussein <80422357+nhussein11@users.noreply.github.com> * Update content * llms * Revise for AH to People Chain * Update title * Fix content * Revise content to generic XCM transfer between parachains * Pin dependencies * Update wording in content * Update content to reflect generic nature of tutorial * Update code according to feedback * Update content * Update develop/toolkit/interoperability/paraspell-xcm-sdk/transfer-tokens-between-parachains.md Co-authored-by: Dawn Kelly <83190195+dawnkelly09@users.noreply.github.com> * Update develop/toolkit/interoperability/paraspell-xcm-sdk/transfer-tokens-between-parachains.md Co-authored-by: Dawn Kelly <83190195+dawnkelly09@users.noreply.github.com> * Update develop/toolkit/interoperability/paraspell-xcm-sdk/transfer-tokens-between-parachains.md Co-authored-by: Dawn Kelly <83190195+dawnkelly09@users.noreply.github.com> * Update develop/toolkit/interoperability/paraspell-xcm-sdk/transfer-tokens-between-parachains.md Co-authored-by: Dawn Kelly <83190195+dawnkelly09@users.noreply.github.com> * python3 scripts/generate_llms.py * Update develop/toolkit/interoperability/paraspell-xcm-sdk/transfer-tokens-between-parachains.md Co-authored-by: Dawn Kelly <83190195+dawnkelly09@users.noreply.github.com> * Update develop/toolkit/interoperability/paraspell-xcm-sdk/transfer-tokens-between-parachains.md Co-authored-by: Dawn Kelly <83190195+dawnkelly09@users.noreply.github.com> * Update develop/toolkit/interoperability/paraspell-xcm-sdk/transfer-tokens-between-parachains.md Co-authored-by: Dawn Kelly <83190195+dawnkelly09@users.noreply.github.com> * Update develop/toolkit/interoperability/paraspell-xcm-sdk/transfer-tokens-between-parachains.md Co-authored-by: Dawn Kelly <83190195+dawnkelly09@users.noreply.github.com> * Update develop/toolkit/interoperability/paraspell-xcm-sdk/transfer-tokens-between-parachains.md Co-authored-by: Dawn Kelly <83190195+dawnkelly09@users.noreply.github.com> * Update develop/toolkit/interoperability/paraspell-xcm-sdk/transfer-tokens-between-parachains.md Co-authored-by: Dawn Kelly <83190195+dawnkelly09@users.noreply.github.com> * Update develop/toolkit/interoperability/paraspell-xcm-sdk/transfer-tokens-between-parachains.md Co-authored-by: Dawn Kelly <83190195+dawnkelly09@users.noreply.github.com> * Update develop/toolkit/interoperability/paraspell-xcm-sdk/transfer-tokens-between-parachains.md Co-authored-by: Dawn Kelly <83190195+dawnkelly09@users.noreply.github.com> * Update develop/toolkit/interoperability/paraspell-xcm-sdk/transfer-tokens-between-parachains.md Co-authored-by: Dawn Kelly <83190195+dawnkelly09@users.noreply.github.com> * Update develop/toolkit/interoperability/paraspell-xcm-sdk/transfer-tokens-between-parachains.md Co-authored-by: Dawn Kelly <83190195+dawnkelly09@users.noreply.github.com> * Update develop/toolkit/interoperability/paraspell-xcm-sdk/transfer-tokens-between-parachains.md Co-authored-by: Dawn Kelly <83190195+dawnkelly09@users.noreply.github.com> * Update develop/toolkit/interoperability/paraspell-xcm-sdk/transfer-tokens-between-parachains.md Co-authored-by: Dawn Kelly <83190195+dawnkelly09@users.noreply.github.com> * Update develop/toolkit/interoperability/paraspell-xcm-sdk/transfer-tokens-between-parachains.md Co-authored-by: Dawn Kelly <83190195+dawnkelly09@users.noreply.github.com> * Update develop/toolkit/interoperability/paraspell-xcm-sdk/transfer-tokens-between-parachains.md Co-authored-by: Dawn Kelly <83190195+dawnkelly09@users.noreply.github.com> * Update develop/toolkit/interoperability/paraspell-xcm-sdk/transfer-tokens-between-parachains.md Co-authored-by: Dawn Kelly <83190195+dawnkelly09@users.noreply.github.com> * Update develop/toolkit/interoperability/paraspell-xcm-sdk/transfer-tokens-between-parachains.md Co-authored-by: Dawn Kelly <83190195+dawnkelly09@users.noreply.github.com> * Update develop/toolkit/interoperability/paraspell-xcm-sdk/transfer-tokens-between-parachains.md Co-authored-by: Dawn Kelly <83190195+dawnkelly09@users.noreply.github.com> * Update content --------- Co-authored-by: Nicolás Hussein <80422357+nhussein11@users.noreply.github.com> Co-authored-by: Taylor Lucero <67010424+Telucero@users.noreply.github.com> Co-authored-by: Dawn Kelly <83190195+dawnkelly09@users.noreply.github.com> * Add tutorial for paying transaction fees with different tokens (#966) * Add tutorial for paying transaction fees with different tokens * fix: llms * Remove tutorial and code snippets for paying transaction fees with different tokens * fix: llms * Update tutorial for sending transactions with alternative fee payment token and adjust navigation link * Enhance tutorial for sending transactions with alternative fee payment token by adding TypeScript module configuration step * fix: llms * Refine tutorial for sending transactions with alternative fee payment token by clarifying implementation steps and enhancing readability * fix: llms * Refine tutorial title for sending transactions with alternative fee payment token to improve clarity * Apply suggestions from code review Co-authored-by: Taylor Lucero <67010424+Telucero@users.noreply.github.com> * fix: llms * Apply suggestions from code review Co-authored-by: Taylor Lucero <67010424+Telucero@users.noreply.github.com> * fix: title * fix: llms --------- Co-authored-by: Taylor Lucero <67010424+Telucero@users.noreply.github.com> * Dawn/improved llms v2 (#1030) * adds `generate_ai_pages.py` with indentation respected and yaml/yml wrapper * updates script to ouput to /ai/pages dir, adds generate_llms_txt.py * removes deprecated script * adds generate_category_bundles.py script + generated files * adds generate_site_index.py + resulting files * delete deprecated script, add main script for llm file pipeline * remove deprecated category files * update to use files in /ai/categories for table * update workflow * fresh llms * Update ai/pages/tutorials-smart-contracts-demo-aplications-deploying-uniswap-v2.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * fresh llms * fixes duplicate terminal outputs, fresh llm files --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Switch llms output directory to be /.ai/ (#1089) * update scripts to use /.ai/ instead of /ai/ * run llms to generate outut to /.ai/ * delete /ai/ * update config * llms * add n8n script (#1100) * add n8n script * test * test * revert --------- Co-authored-by: Taylor Lucero <Telucero@users.noreply.github.com> * Dark mode images fix (#1110) * mermaid fix * fix * fix * llms * fix minor rendering issues (#1115) * fix minor issues * llms * update spacing (#1116) * Reorder APIs on the sidebar (#1122) Since it is not in alphabetical order anyway, as far as I know "Polkadart" should be before "Polkadot-API" Dart, comes before TypeScript, Python comes before TypeScript, and so on, but it seems the only "error" is that Dedot is listed first. If you don't mind us making this change @sinzii ? I really appreciate all your hard work. * Dawn/per page llm staging (#1101) * Copy js file from copy-to-llm (#909) Co-authored-by: Leonardo Custodio <leonardo.custodio@parity.io> * script review, added TODOs and comments re: updates to work with resolved Markdown files we will use for per-page content * updates comment * tweaks to script to prep for per page md file wireup * continue updating script to use new generated files * iterating on script * WIP * fresh llms * adds view icons to table * removes deprecated placeholder files * whitespace * fresh llms * removes view icons, fresh llms * fresh llms * updates exports, cleans up code * update exports * clean, clean, clean the code * remove debug window for prod * code clean up * more clean up * formatting/styling clean up * apply review feedback * fresh llms * clean code, remove deprecated script * script clean up and testing * script clean up, fresh llms * clean up contents, prettier --------- Co-authored-by: Leonardo Custodio <leonardo.custodio@parity.io> * Patch per-page LLM widget (#1133) * removes unneeded checks and processing to reduce console noise and confusing errors. * prettier * remove extra normalizing check * patch remove deprecated logic * patch the patches * pathcy patch patcherson * clean and patch * remove blank line at end * patching stuff * patch error handling * patch error handling * Apply suggestion from @Copilot Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Add Wallet Tools section with LunoKit integration library (#1121) * Add Wallet Tools section with LunoKit integration library Add a new "Wallet Tools" section for libraries and SDKs that help developers quickly and easily integrate wallet functionality into their dApps. Add LunoKit - a React library that simplifies wallet integration with unified API for 9+ Polkadot wallets, pre-built components, TypeScript support, and compatibility with major Polkadot APIs. Helps developers add wallet functionality without building from scratch.LunoKit is supported by the Web3 Foundation Grants Program. * fix: llms * fix: site-index * fix: merge conflicts --------- Co-authored-by: nhussein11 <nicolashussein14@gmail.com> * update build workflow * update script (#1151) Co-authored-by: Taylor Lucero <Telucero@users.noreply.github.com> * Fix - Add chain spec path argument (#1136) * Add chain spec path argument * llm * fix: llms * fix: llms * fresh llms --------- Co-authored-by: nhussein11 <nicolashussein14@gmail.com> Co-authored-by: DAWN KELLY <dawnkelly09@gmail.com> * patch script to remove last modified lines from site-index.json (#1141) * New Card Styling (#1142) * remove hr from manual cards * llms * fresh llms --------- Co-authored-by: Erin Shaben <eshaben@icloud.com> * removes deprecated files related to legacy vale workflow (#1180) * Seo November (#1172) * wip * llms * fix * fresh llms * update hardhat documentation for web0 hackathon (#1227) * Dawn/patch llms scripts (#1197) * Adds check to delete old files from /.ai/ before writing updated one to keep docs and llm files in sync * adds word count and token estimates to per page files * adds word count and token estimate to category files * update token function per feedback from Copilot * removes output of token and word counts to pages to avoid frequent merge conflicts. Functions for determining counts left in place. * fresh llms without word and token counts * Update .CONTRIBUTING.md (#1199) * Merge remote-tracking branch 'origin/master' into staging/product-ia --------- Co-authored-by: Muhammad Arsalan Hussain <93572504+mh07607@users.noreply.github.com> Co-authored-by: Lucas Malizia <131050418+0xlukem@users.noreply.github.com> Co-authored-by: Bruno Galvao <brunopgalvao@gmail.com> Co-authored-by: ottovlotto <142217647+ottovlotto@users.noreply.github.com> Co-authored-by: deigenvektor.io <git@deigenvektor.io> Co-authored-by: Dawn Kelly <83190195+dawnkelly09@users.noreply.github.com> Co-authored-by: Leonardo Custodio <leonardo@custodio.me> Co-authored-by: Nicolás Hussein <80422357+nhussein11@users.noreply.github.com> Co-authored-by: Taylor Lucero <67010424+Telucero@users.noreply.github.com> Co-authored-by: Nikos Kontakis <wirednkod@gmail.com> Co-authored-by: DAWN KELLY <dawnkelly09@gmail.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Taylor Lucero <Telucero@users.noreply.github.com> Co-authored-by: Leonardo Custodio <leonardo.custodio@parity.io> Co-authored-by: cris <mail1737655@gmail.com> Co-authored-by: nhussein11 <nicolashussein14@gmail.com> Co-authored-by: albertov19 <64150856+albertov19@users.noreply.github.com> Co-authored-by: Bader Youssef <ibnbassem@gmail.com> Co-authored-by: Utkarsh Bhardwaj <utkarsh.bhardwaj@parity.io>
📝 Description
Provide a clear and concise description of your changes.
🔍 Review Preference
Choose one:
🤖 AI-Ready Docs
If content changed, regenerate AI files:
python3 scripts/generate_llms.py✅ Checklist