Skip to content
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

docs: add further snippets with new infrastructure #3297

Open
wants to merge 140 commits into
base: master
Choose a base branch
from

Conversation

maschad
Copy link
Member

@maschad maschad commented Oct 9, 2024

Release notes

In this release, we:

  • Revised our code snippets to use a WYSIWYG format

Summary

This PR builds on the work @arboleya did in #2651 by introducing some more snippets that have been migrated to the new infra. Once this is merged into that branch then the docs can be refactored to use the folder structure in #3205

Checklist

  • All changes are covered by tests (or not applicable)
  • All changes are documented (or not applicable)
  • I reviewed the entire PR myself (preferably, on GH UI)
  • I described all Breaking Changes (or there's none)

maschad and others added 15 commits October 1, 2024 11:17
Co-authored-by: Peter Smith <16990131+petertonysmith94@users.noreply.github.com>
Co-authored-by: Peter Smith <16990131+petertonysmith94@users.noreply.github.com>
Co-authored-by: Peter Smith <16990131+petertonysmith94@users.noreply.github.com>
Co-authored-by: Peter Smith <16990131+petertonysmith94@users.noreply.github.com>
* build(deps): bump the deps-minor group with 9 updates

Bumps the deps-minor group with 9 updates:

| Package | From | To |
| --- | --- | --- |
| [@types/web](https://github.com/microsoft/TypeScript-DOM-Lib-Generator) | `0.0.164` | `0.0.167` |
| [knip](https://github.com/webpro-nl/knip/tree/HEAD/packages/knip) | `5.30.5` | `5.30.6` |
| [vite](https://github.com/vitejs/vite/tree/HEAD/packages/vite) | `5.4.7` | `5.4.8` |
| [@wagmi/connectors](https://github.com/wevm/wagmi/tree/HEAD/packages/connectors) | `5.1.12` | `5.1.14` |
| [@wagmi/core](https://github.com/wevm/wagmi/tree/HEAD/packages/core) | `2.13.6` | `2.13.8` |
| [@types/react](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/react) | `18.3.9` | `18.3.10` |
| [typedoc-plugin-markdown](https://github.com/typedoc2md/typedoc-plugin-markdown/tree/HEAD/packages/typedoc-plugin-markdown) | `4.2.7` | `4.2.8` |
| [vue](https://github.com/vuejs/core) | `3.5.8` | `3.5.10` |
| [@tanstack/router-plugin](https://github.com/TanStack/router/tree/HEAD/packages/router-plugin) | `1.58.4` | `1.58.12` |

Updates `@types/web` from 0.0.164 to 0.0.167
- [Release notes](https://github.com/microsoft/TypeScript-DOM-Lib-Generator/releases)
- [Commits](https://github.com/microsoft/TypeScript-DOM-Lib-Generator/compare/@types/web@0.0.164...@types/web@0.0.167)

Updates `knip` from 5.30.5 to 5.30.6
- [Release notes](https://github.com/webpro-nl/knip/releases)
- [Changelog](https://github.com/webpro-nl/knip/blob/main/packages/knip/.release-it.json)
- [Commits](https://github.com/webpro-nl/knip/commits/5.30.6/packages/knip)

Updates `vite` from 5.4.7 to 5.4.8
- [Release notes](https://github.com/vitejs/vite/releases)
- [Changelog](https://github.com/vitejs/vite/blob/v5.4.8/packages/vite/CHANGELOG.md)
- [Commits](https://github.com/vitejs/vite/commits/v5.4.8/packages/vite)

Updates `@wagmi/connectors` from 5.1.12 to 5.1.14
- [Release notes](https://github.com/wevm/wagmi/releases)
- [Changelog](https://github.com/wevm/wagmi/blob/main/packages/connectors/CHANGELOG.md)
- [Commits](https://github.com/wevm/wagmi/commits/@wagmi/connectors@5.1.14/packages/connectors)

Updates `@wagmi/core` from 2.13.6 to 2.13.8
- [Release notes](https://github.com/wevm/wagmi/releases)
- [Changelog](https://github.com/wevm/wagmi/blob/main/packages/core/CHANGELOG.md)
- [Commits](https://github.com/wevm/wagmi/commits/@wagmi/core@2.13.8/packages/core)

Updates `@types/react` from 18.3.9 to 18.3.10
- [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
- [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/react)

Updates `typedoc-plugin-markdown` from 4.2.7 to 4.2.8
- [Release notes](https://github.com/typedoc2md/typedoc-plugin-markdown/releases)
- [Changelog](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/CHANGELOG.md)
- [Commits](https://github.com/typedoc2md/typedoc-plugin-markdown/commits/typedoc-plugin-markdown@4.2.8/packages/typedoc-plugin-markdown)

Updates `vue` from 3.5.8 to 3.5.10
- [Release notes](https://github.com/vuejs/core/releases)
- [Changelog](https://github.com/vuejs/core/blob/main/CHANGELOG.md)
- [Commits](vuejs/core@v3.5.8...v3.5.10)

Updates `@tanstack/router-plugin` from 1.58.4 to 1.58.12
- [Release notes](https://github.com/TanStack/router/releases)
- [Commits](https://github.com/TanStack/router/commits/v1.58.12/packages/router-plugin)

---
updated-dependencies:
- dependency-name: "@types/web"
  dependency-type: direct:development
  update-type: version-update:semver-patch
  dependency-group: deps-minor
- dependency-name: knip
  dependency-type: direct:development
  update-type: version-update:semver-patch
  dependency-group: deps-minor
- dependency-name: vite
  dependency-type: direct:development
  update-type: version-update:semver-patch
  dependency-group: deps-minor
- dependency-name: "@wagmi/connectors"
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: deps-minor
- dependency-name: "@wagmi/core"
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: deps-minor
- dependency-name: "@types/react"
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: deps-minor
- dependency-name: typedoc-plugin-markdown
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: deps-minor
- dependency-name: vue
  dependency-type: direct:development
  update-type: version-update:semver-patch
  dependency-group: deps-minor
- dependency-name: "@tanstack/router-plugin"
  dependency-type: direct:development
  update-type: version-update:semver-patch
  dependency-group: deps-minor
...

Signed-off-by: dependabot[bot] <support@github.com>

* build: update dependency changeset

* docs: update changeset

* Update .changeset/tall-lemons-explode.md

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: chad <chad.nehemiah94@gmail.com>
Co-authored-by: Peter Smith <16990131+petertonysmith94@users.noreply.github.com>
* build(deps): bump chalk from 4.0.0 to 4.1.2

Bumps [chalk](https://github.com/chalk/chalk) from 4.0.0 to 4.1.2.
- [Release notes](https://github.com/chalk/chalk/releases)
- [Commits](chalk/chalk@v4.0.0...v4.1.2)

---
updated-dependencies:
- dependency-name: chalk
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>

* build: update dependency changeset

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Copy link

vercel bot commented Oct 9, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
fuels-template ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 9, 2024 5:16pm
ts-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 9, 2024 5:16pm

Copy link

codspeed-hq bot commented Oct 9, 2024

CodSpeed Performance Report

Merging #3297 will not alter performance

Comparing mc/continue-infra-for-snippets (a665481) with master (c84abb3)

Summary

✅ 18 untouched benchmarks

Copy link
Contributor

github-actions bot commented Oct 9, 2024

Coverage Report:

Lines Branches Functions Statements
74.29%(-1.99%) 70.05%(-0.22%) 75.06%(-0.2%) 74.45%(-1.95%)
Changed Files:
Ok File (✨=New File) Lines Branches Functions Statements
🔴 ✨ apps/docs-snippets2/src/create-fuels/decrement-counter.ts 0%
(+0%)
100%
(+100%)
100%
(+100%)
0%
(+0%)
🔴 ✨ apps/docs-snippets2/src/encoding/encode-and-decode.ts 0%
(+0%)
100%
(+100%)
0%
(+0%)
0%
(+0%)
🔴 ✨ apps/docs-snippets2/src/encoding/working-with-bytes.ts 0%
(+0%)
100%
(+100%)
100%
(+100%)
0%
(+0%)
🔴 ✨ apps/docs-snippets2/src/scripts/script-custom-transaction.ts 0%
(+0%)
100%
(+100%)
100%
(+100%)
0%
(+0%)
🔴 ✨ apps/docs-snippets2/src/scripts/script-with-configurable.ts 0%
(+0%)
100%
(+100%)
100%
(+100%)
0%
(+0%)
🔴 ✨ apps/docs-snippets2/src/testing/launching-a-test-node.node.ts 0%
(+0%)
100%
(+100%)
100%
(+100%)
0%
(+0%)
🔴 ✨ apps/docs-snippets2/src/testing/tweaking-the-blockchain.ts 0%
(+0%)
0%
(+0%)
100%
(+100%)
0%
(+0%)
🔴 ✨ apps/docs-snippets2/src/typegend/contracts/EchoValues.ts 66.66%
(+66.66%)
100%
(+100%)
0%
(+0%)
66.66%
(+66.66%)
🔴 ✨ apps/docs-snippets2/src/typegend/contracts/EchoValuesFactory.ts 100%
(+100%)
0%
(+0%)
100%
(+100%)
100%
(+100%)
🔴 ✨ apps/docs-snippets2/src/typegend/scripts/ScriptTransferToContract.ts 80%
(+80%)
100%
(+100%)
0%
(+0%)
80%
(+80%)
🔴 ✨ apps/docs-snippets2/src/utilities/unit-conversion.ts 0%
(+0%)
100%
(+100%)
100%
(+100%)
0%
(+0%)
🔴 ✨ apps/docs-snippets2/src/wallet-manager/getting-started-with-wallet-manager.ts 0%
(+0%)
100%
(+100%)
100%
(+100%)
0%
(+0%)
🔴 ✨ apps/docs-snippets2/src/wallet-manager/locking-and-unlocking-wallet-manager.ts 0%
(+0%)
100%
(+100%)
100%
(+100%)
0%
(+0%)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Requests pertinent to documentation
Projects
None yet
4 participants