diff --git a/.github/styles/Grammarly.csv b/.github/styles/Grammarly.csv index d534942f..a261516c 100644 --- a/.github/styles/Grammarly.csv +++ b/.github/styles/Grammarly.csv @@ -189,6 +189,7 @@ StrakEx,StarkEx,"typo fix" "the Neon,The Neon","Neon","In most instances, 'The Neon EVM' can be stated as Neon EVM" "the Mainnet,The Mainnet","Mainnet","In most instances, The Mainnet can be stated as Mainnet" "the Devnet,The Devnet","Devnet","'The Devnet' should most often simply be stated as Devnet" +"toke,Toke,tokes,Tokes","token","Do you really mean to smoke/smokes?!" "token account,Token account,token Account,token-account",Token Account,"Existing style, maintain consistency" "unbeatable","competitive","Warning -- this is a legally sensitive term. However, context is everything: it may be that the original text is more appropriate." "Undetectable","Discreet","Warning -- this is a legally sensitive term. However, context is everything: it may be that the original text is more appropriate." diff --git a/README.md b/README.md index 6a3578de..0c603086 100644 --- a/README.md +++ b/README.md @@ -86,6 +86,8 @@ You can either lint **all** Markdown files with `vale .`, or you can name a spec ### Tabs boilerplate +> Warning Heading links do not work *within* tabs >> Only once the correct tab is selected would a link function making them useless for cross-page linking (there is probably a workaround/plugin todo). + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -107,6 +109,41 @@ import TabItem from '@theme/TabItem'; with authentication via [GitHub](https://github.com/anonNeon) +## Walkthrough boilerplate + +When creating user walkthroughs, it is important to think about what structure and heirachy supports end users. The style applied in this dev portal is: + +[H2] TL;DR +Tell the user in 3 bullet points or less what they need to know to either +- avoid using the tutorial entirely +- decide whether they will use it +{todo: in the future, we want to add a time required for the walkthrough here} + +[H2] Introduction +The assumption is that less than 30% of users need an intro >> this item supports the bottom tail + +[H2] Prerequisites +What does the user need to have or know to achieve success? NB stay sane else the list could become long! + +[H2]How to do this thing +The first heading gathers the entire tutorial into one structure + +[H3] Step 1: Do this first thing +Break the tutorial down into logical chunks, e.g. 1. go clone and install a repo 2. configure a file 3. Run the configured program +The H3 is the final item that will be shown in the TOC (table of contents) on the RHS of the page, this allows the user to scan the TOC to gain an impression of what they are getting themselves into and to skip ahead according to their setup/knowledge level + +## Information pages boilerplate +[H2] TL;DR +Tell the user in 3 bullet points or less what they need to know to either +- avoid reading the page entirely +- decide whether they want to read it + +[H2] Introduction +Tell the users what this page is about + +[H2]/[H3] Content -- nest the content into H2s and H3s for TOC presence -- H4 and H5 can be applied, but remember these are nested within the page and do not appear in the TOC. The user should be able to get an idea of what the page is about *without* reading the full intro -- just by using the TL;DR and/or TOC. + +Example page: docs/evm_compatibility/overview ## Troubleshooting @@ -114,4 +151,8 @@ You pull main and can no longer build. Don't fret, someone probably changed a de `npm install` and then build or serve and see if that fixes it +## End user support + +The current search is provided by algolia.com +We wish to expand this functionality by implementing Mava AI (ticket with FE team) diff --git a/docs/developing/deploy_facilities/configure_foundry.md b/docs/developing/deploy_facilities/configure_foundry.md index cdc343fa..606294fc 100644 --- a/docs/developing/deploy_facilities/configure_foundry.md +++ b/docs/developing/deploy_facilities/configure_foundry.md @@ -4,7 +4,7 @@ proofedDate: 20231116 iterationBy: na includedInSite: true approvedBy: na -comment: +comment: Trying to return link that was killing the build todo test --- Foundry is a blazing fast, portable,modular toolkit for Ethereum application development written in Rust. @@ -34,3 +34,4 @@ The parameters for `forge create` command include: * `--legacy`: This parameter is being passed to use legacy transactions _(Neon EVM currently [doesn't support EIP-1559 transactions](/docs/evm_compatibility/overview#shared-standards-and-features))_ +## What next? See the [tutorial on how to use Foundry](/docs/developing/deploy_facilities/using_foundry) to deploy to Neon EVM.