Skip to content

Commit

Permalink
Merge pull request #119 from neonlabsorg/fixes#2
Browse files Browse the repository at this point in the history 
Fixes#2
  • Loading branch information
@m4sterbunny
m4sterbunny authored Dec 5, 2023
2 parents 1544571 + 505eaab commit de75feb
Show file tree
Hide file tree
Showing 3 changed files with 44 additions and 1 deletion.
1 change: 1 addition & 0 deletions .github/styles/Grammarly.csv
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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."
Expand Down
41 changes: 41 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Check warning on line 89 in README.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Google-adapted.Contractions] Feel free to use 'don't' instead of 'do not'.

Raw Output:
{"message": "[Google-adapted.Contractions] Feel free to use 'don't' instead of 'do not'.", "location": {"path": "README.md", "range": {"start": {"line": 89, "column": 25}}}, "severity": "INFO"}

Check warning on line 89 in README.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Google-adapted.Passive] In general, use active voice instead of passive voice ('is selected').

Raw Output:
{"message": "[Google-adapted.Passive] In general, use active voice instead of passive voice ('is selected').", "location": {"path": "README.md", "range": {"start": {"line": 89, "column": 80}}}, "severity": "INFO"}

Check warning on line 89 in README.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[write-good-adapted.todo] 'todo' left in text

Raw Output:
{"message": "[write-good-adapted.todo] 'todo' left in text", "location": {"path": "README.md", "range": {"start": {"line": 89, "column": 196}}}, "severity": "WARNING"}

Check failure on line 89 in README.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'todo'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'todo'?", "location": {"path": "README.md", "range": {"start": {"line": 89, "column": 196}}}, "severity": "ERROR"}
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

Expand All @@ -107,11 +109,50 @@ import TabItem from '@theme/TabItem';

with authentication via [GitHub](https://github.com/anonNeon)

## Walkthrough boilerplate

Check failure on line 112 in README.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Walkthrough'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'Walkthrough'?", "location": {"path": "README.md", "range": {"start": {"line": 112, "column": 4}}}, "severity": "ERROR"}

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:

Check failure on line 114 in README.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'walkthroughs'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'walkthroughs'?", "location": {"path": "README.md", "range": {"start": {"line": 114, "column": 20}}}, "severity": "ERROR"}

Check warning on line 114 in README.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Google-adapted.Contractions] Feel free to use 'it's' instead of 'it is'.

Raw Output:
{"message": "[Google-adapted.Contractions] Feel free to use 'it's' instead of 'it is'.", "location": {"path": "README.md", "range": {"start": {"line": 114, "column": 34}}}, "severity": "INFO"}

Check failure on line 114 in README.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'heirachy'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'heirachy'?", "location": {"path": "README.md", "range": {"start": {"line": 114, "column": 84}}}, "severity": "ERROR"}

Check failure on line 114 in README.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'dev'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'dev'?", "location": {"path": "README.md", "range": {"start": {"line": 114, "column": 139}}}, "severity": "ERROR"}

[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

Check warning on line 119 in README.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Google-adapted.Will] Avoid using 'will'. Stick to the present tense.

Raw Output:
{"message": "[Google-adapted.Will] Avoid using 'will'. Stick to the present tense.", "location": {"path": "README.md", "range": {"start": {"line": 119, "column": 23}}}, "severity": "WARNING"}
{todo: in the future, we want to add a time required for the walkthrough here}

Check warning on line 120 in README.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[write-good-adapted.todo] 'todo' left in text

Raw Output:
{"message": "[write-good-adapted.todo] 'todo' left in text", "location": {"path": "README.md", "range": {"start": {"line": 120, "column": 2}}}, "severity": "WARNING"}

Check failure on line 120 in README.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'walkthrough'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'walkthrough'?", "location": {"path": "README.md", "range": {"start": {"line": 120, "column": 62}}}, "severity": "ERROR"}

[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!

Check failure on line 126 in README.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Google-adapted.Exclamation] Don't use exclamation points in text.

Raw Output:
{"message": "[Google-adapted.Exclamation] Don't use exclamation points in text.", "location": {"path": "README.md", "range": {"start": {"line": 126, "column": 104}}}, "severity": "ERROR"}

[H2]How to do this thing
The first heading gathers the entire tutorial into one structure

[H3] Step 1: Do this first thing

Check warning on line 131 in README.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Google-adapted.Colons] ': D' should be in lowercase.

Raw Output:
{"message": "[Google-adapted.Colons] ': D' should be in lowercase.", "location": {"path": "README.md", "range": {"start": {"line": 131, "column": 12}}}, "severity": "WARNING"}
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

Check failure on line 132 in README.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'repo'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'repo'?", "location": {"path": "README.md", "range": {"start": {"line": 132, "column": 77}}}, "severity": "ERROR"}

Check warning on line 132 in README.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Google-adapted.max-sentence-length] This sentence has more than 40 words in it. Try making it shorter.

Raw Output:
{"message": "[Google-adapted.max-sentence-length] This sentence has more than 40 words in it. Try making it shorter.", "location": {"path": "README.md", "range": {"start": {"line": 132, "column": 105}}}, "severity": "WARNING"}
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

Check warning on line 133 in README.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Google-adapted.Will] Avoid using 'will'. Stick to the present tense.

Raw Output:
{"message": "[Google-adapted.Will] Avoid using 'will'. Stick to the present tense.", "location": {"path": "README.md", "range": {"start": {"line": 133, "column": 31}}}, "severity": "WARNING"}

Check warning on line 133 in README.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Google-adapted.Passive] In general, use active voice instead of passive voice ('be shown').

Raw Output:
{"message": "[Google-adapted.Passive] In general, use active voice instead of passive voice ('be shown').", "location": {"path": "README.md", "range": {"start": {"line": 133, "column": 36}}}, "severity": "INFO"}

## 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.

Check failure on line 144 in README.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Google-adapted.Units] Put a nonbreaking space between the number and the unit in '2s'.

Raw Output:
{"message": "[Google-adapted.Units] Put a nonbreaking space between the number and the unit in '2s'.", "location": {"path": "README.md", "range": {"start": {"line": 144, "column": 45}}}, "severity": "ERROR"}

Example page: docs/evm_compatibility/overview

## Troubleshooting

You pull main and can no longer build. Don't fret, someone probably changed a dependency do:
`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)

3 changes: 2 additions & 1 deletion docs/developing/deploy_facilities/configure_foundry.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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.

0 comments on commit de75feb

Please sign in to comment.