kylefang/bro-sdk
1
0
Fork 0
mirror of https://github.com/Brotocol-xyz/bro-sdk.git synced 2026-01-12 06:44:18 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: Update dev-instructions file.

Browse Source
This commit is contained in:
Facundo Lerena
2025-04-30 16:17:59 -03:00
parent 78de614697
commit f8739f7f17
2 changed files with 3 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
.prettierrc.cjs
View File

@@ -1,6 +1,6 @@
module.exports = {
trailingComma: "all",
semi: false, // set to true to format docs/readmeCodeSnippets.ts with semicolons
semi: false,
arrowParens: "avoid",
singleQuote: false,
}

8
docs/dev-instructions.md
View File

@@ -25,15 +25,11 @@ Open `http://localhost:8080` in your browser to view the documentation.
## README Code Snippets
Version history of the README code snippets is tracked at [`docs/readmeCodeSnippets.ts`](../docs/readmeCodeSnippets.ts).
### Formatting
To format `docs/readmeCodeSnippets.ts` with semicolons, temporarily set `semi: true` in the `.prettierrc.cjs` file. **Do not commit changes to `.prettierrc.cjs`.**
Version history of the README code snippets is tracked at [`../examples/code-snippets`](../examples/code-snippets).
### Dependencies
To read or write `docs/readmeCodeSnippets.ts`, you may need to temporarily install dependencies to ensure code correctness. **Do not commit any changes to `package.json` or `pnpm-lock.yaml`** resulting from these temporary installations.
To read or write `examples/code-snippets`, you may need to temporarily install dependencies to ensure code correctness. **Do not commit any changes to `package.json` or `pnpm-lock.yaml`** resulting from these temporary installations.
```bash
pnpm install -D ethers