Skip to content

DOCS: add vale prose linter and configuration#242

Merged
3 commits merged intomainfrom
ops-26-add-vale
Sep 8, 2025
Merged

DOCS: add vale prose linter and configuration#242
3 commits merged intomainfrom
ops-26-add-vale

Conversation

@pgarmaz-da
Copy link
Contributor

@pgarmaz-da pgarmaz-da commented Sep 3, 2025

Changes

  • add vale configuration files
  • update docs Makefile to provide targets for running vale to check for errors or suggestions
  • update nix/shell.nix to provide vale and docutils to ci configuration
  • add .envrc to docs path to load CI nixpkgs
  • update docs Makefile to reflect change with tooling being provided by nix flakes
  • update docs README.md to reflect changes with addition of vale and .envrc

Notes

  • vale-errors check is not being run in CI due to a number of errors that need to be fixed/checked, this is to be done in a subsequent issue/PR - link to CircleCI run where errors are shown
  • changes to how docs tooling was source is due to vale having a dependency on the rst2html application which is provided by the doctuils package

@pgarmaz-da pgarmaz-da marked this pull request as ready for review September 4, 2025 22:01
@pgarmaz-da pgarmaz-da requested a review from a team as a code owner September 4, 2025 22:01
@ghost ghost assigned TheChronicMonster and unassigned TheChronicMonster Sep 8, 2025
@ghost ghost merged commit 8534d9d into main Sep 8, 2025
2 checks passed
@ghost ghost deleted the ops-26-add-vale branch September 8, 2025 22:44
anhlh2311 added a commit to anhlh2311/cn-quickstart that referenced this pull request Sep 30, 2025
* main: (33 commits)
  docs: capture-logs date or gdate (digital-asset#265)
  docs: canton console connections (digital-asset#272)
  docs: guidance for safari users (digital-asset#271)
  Add daml-test to CircleCI and split up configuration (digital-asset#268)
  fix canton OOM and reduce canton memory requirement from ~12 GB to ~3 GB
  fixed bootstrap loading (digital-asset#266)
  docs: resolve syntax comments re 167 (digital-asset#259)
  move away from auth.principal.attributes to auth.authorities to store partyId and tenantId (digital-asset#260)
  Issue 236 improve standards in open api specs (digital-asset#252)
  fix: code backtick (digital-asset#256)
  docs: Remove some extraneous tick marks. (digital-asset#255)
  docs: resize images (digital-asset#254)
  Bump vite from 6.3.5 to 6.3.6 in /quickstart/frontend (digital-asset#247)
  Bump axios from 1.9.0 to 1.12.1 in /quickstart/frontend (digital-asset#253)
  docs: fast path installation (digital-asset#250)
  curl_check: treat HTTP 201 and 204 as success (digital-asset#251)
  fix typo in topology diagram (digital-asset#249)
  dupdate explore demo w biz case better toc (digital-asset#248)
  DOCS: add vale prose linter and configuration (digital-asset#242)
  fixes bug to disallow duplicate tenantId and combination of clientId and issuerUrl (digital-asset#233)
  ...

# Conflicts:
#	quickstart/compose.yaml
#	quickstart/daml/.gitignore
#	quickstart/docker/create-app-install-request/run.sh
This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants