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

chore(docs): Minor fixes on local documentation development workflows #7684

Merged
merged 4 commits into from
Mar 12, 2025

Conversation

Savio-Sou
Copy link
Collaborator

Summary*

  • Supplement missing step of generating versions.json in yarn dev
  • Fix missing cache cleaning in yarn clean
  • Trim unnecessary commands and supplement missing commands in README
  • Improve readability of steps in README

Documentation*

Check one:

  • No documentation needed.
  • Documentation included in this PR.
  • [For Experimental Features] Documentation to be submitted in a separate PR.

PR Checklist*

  • I have tested the changes locally.
  • I have formatted the changes with Prettier and/or cargo fmt on default settings.

@Savio-Sou Savio-Sou requested a review from signorecello March 12, 2025 17:43
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Mar 12, 2025
Copy link
Contributor

github-actions bot commented Mar 12, 2025

Copy link

New, updated, and removed dependencies detected. Learn more about Socket for GitHub ↗︎

Package New capabilities Transitives Size Publisher
npm/@aztec/bb.js@0.77.1 Transitive: environment +5 17.7 MB charlielye
npm/@esm-bundle/chai@4.3.4 None +1 1.13 MB joeldenning
npm/@ltd/j-toml@1.38.0 None 0 812 kB ltd
npm/@nomicfoundation/hardhat-chai-matchers@2.0.8 None +5 433 kB schaable
npm/@nomicfoundation/hardhat-ethers@3.0.8 None +1 283 kB kanej
npm/@web/dev-server-esbuild@0.3.6 filesystem Transitive: environment, eval, network, shell, unsafe +122 218 MB modern-web
npm/@web/dev-server-import-maps@0.2.1 None +1 155 kB modern-web
npm/@web/test-runner-playwright@0.11.0 Transitive: environment, eval, filesystem, network, shell, unsafe +178 11 MB modern-web
npm/@web/test-runner@0.18.3 Transitive: environment, eval, filesystem, network, shell, unsafe +308 90.7 MB modern-web
npm/ethers@6.13.5 network Transitive: environment +8 18.5 MB ricmoo
npm/hardhat@2.22.19 environment, filesystem, network, shell Transitive: eval, unsafe +156 169 MB kanej
npm/smol-toml@1.3.1 None 0 99 kB cyyynthia
npm/toml@3.0.0 None 0 144 kB binarymuse
npm/tslog@4.9.3 None 0 175 kB eterehov

🚮 Removed packages: npm/@eslint-community/eslint-utils@4.4.0, npm/@humanwhocodes/module-importer@1.0.1, npm/@jridgewell/trace-mapping@0.3.9, npm/@nodelib/fs.stat@2.0.5, npm/@nodelib/fs.walk@1.2.8, npm/@npmcli/fs@3.1.0, npm/@pkgjs/parseargs@0.11.0, npm/@tsconfig/node10@1.0.9, npm/@tsconfig/node12@1.0.11, npm/@tsconfig/node14@1.0.3, npm/acorn-jsx@5.3.2, npm/ajv@6.12.6, npm/ansi-colors@4.1.3, npm/ansi-regex@6.0.1, npm/ansi-styles@6.2.1, npm/arg@4.1.3, npm/argparse@2.0.1, npm/balanced-match@1.0.2, npm/binary-extensions@2.2.0, npm/brace-expansion@1.1.11, npm/braces@3.0.2, npm/callsites@3.1.0, npm/camelcase@6.3.0, npm/chownr@2.0.0, npm/clean-stack@2.2.0, npm/clsx@1.2.1, npm/color-convert@2.0.1, npm/color-name@1.1.4, npm/concat-map@0.0.1, npm/create-require@1.1.1, npm/cross-spawn@7.0.3, npm/eastasianwidth@0.2.0, npm/emoji-regex@9.2.2, npm/encoding@0.1.13, npm/err-code@2.0.3, npm/escalade@3.1.1, npm/escape-string-regexp@4.0.0, npm/esprima@4.0.1, npm/esrecurse@4.3.0, npm/estraverse@5.3.0, npm/esutils@2.0.3, npm/exponential-backoff@3.1.1, npm/fast-deep-equal@3.1.3, npm/fast-json-stable-stringify@2.1.0, npm/fast-levenshtein@2.0.6, npm/fill-range@7.0.1, npm/find-up@5.0.0, npm/foreground-child@3.1.1, npm/get-caller-file@2.0.5, npm/graphemer@1.4.0, npm/has-flag@4.0.0, npm/he@1.2.0, npm/http-cache-semantics@4.1.1, npm/iconv-lite@0.6.3, npm/imurmurhash@0.1.4, npm/indent-string@4.0.0, npm/is-binary-path@2.1.0, npm/is-extglob@2.1.1, npm/is-fullwidth-code-point@3.0.0, npm/is-glob@4.0.3, npm/is-lambda@1.0.1, npm/is-number@7.0.0, npm/is-typedarray@1.0.0, npm/is-unicode-supported@0.1.0, npm/isexe@2.0.0, npm/js-yaml@4.1.0, npm/json-buffer@3.0.1, npm/json-schema-traverse@0.4.1, npm/json-stable-stringify-without-jsonify@1.0.1, npm/locate-path@6.0.0, npm/lodash.merge@4.6.2, npm/make-error@1.3.6, npm/merge2@1.4.1, npm/micromatch@4.0.5, npm/minipass-pipeline@1.2.4, npm/minipass-sized@1.0.3, npm/minizlib@2.1.2, npm/ms@2.1.2, npm/natural-compare@1.4.0, npm/negotiator@0.6.3, npm/normalize-path@3.0.0, npm/p-limit@3.1.0, npm/p-locate@5.0.0, npm/parent-module@1.0.1, npm/path-browserify@1.0.1, npm/path-exists@4.0.0, npm/path-key@3.1.1, npm/prelude-ls@1.2.1, npm/promise-retry@2.0.1, npm/randombytes@2.1.0, npm/require-directory@2.1.1, npm/resolve-from@4.0.0, npm/retry@0.12.0, npm/reusify@1.0.4, npm/safe-buffer@5.2.1, npm/safer-buffer@2.1.2, npm/shebang-command@2.0.0, npm/shebang-regex@3.0.0, npm/signal-exit@3.0.7, npm/smart-buffer@4.2.0, npm/string-width-cjs@4.2.3, npm/strip-ansi-cjs@6.0.1, npm/strip-json-comments@3.1.1, npm/supports-color@7.2.0, npm/to-regex-range@5.0.1, npm/type-check@0.4.0, npm/type-detect@4.0.8, npm/unique-filename@3.0.0, npm/unique-slug@4.0.0, npm/v8-compile-cache-lib@3.0.1, npm/which@2.0.2, npm/wrap-ansi-cjs@7.0.0, npm/y18n@5.0.8, npm/yallist@4.0.0, npm/yn@3.1.1, npm/yocto-queue@0.1.0

View full report↗︎

@Savio-Sou
Copy link
Collaborator Author

Savio-Sou commented Mar 12, 2025

@TomAFrench do we use cut_version.sh anywhere?

Running yarn workspace docs version as originally documented doesn't trigger the version command, but spits out the following error instead:

Unknown Syntax Error: Not enough positional arguments.

$ yarn version [-d,--deferred] [-i,--immediate] <strategy>

Thinking if we should simply remove cut_version.sh and the version command.

Copy link
Contributor

FYI @noir-lang/developerrelations on Noir doc changes.

@TomAFrench
Copy link
Member

We use it as part of releases so it shouldn't be removed.

@Savio-Sou
Copy link
Collaborator Author

Cool, no additional changes from me in that case; thanks!

@TomAFrench TomAFrench added this pull request to the merge queue Mar 12, 2025
Merged via the queue into master with commit 77ae087 Mar 12, 2025
105 checks passed
@TomAFrench TomAFrench deleted the ss/docs-fix-local branch March 12, 2025 20:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants