Conversation
paddyroddy
added
enhancement
paddyroddy
commented
Jun 10, 2025
| :: network-yes {"position":"1050,1050","size":"100,100"} | ||
| The wizard calls his familiar, a large fuzzy spider. It hands you a magical spider web which speeds up the process of cataloguing the spells. | ||
|
|
Member
Author
There was a problem hiding this comment.
VSCode didn't like this line ending
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
paddyroddy
commented
Jun 10, 2025
Comment on lines
+7
to
+8
| [formats] | ||
| twee = md |
Member
Author
There was a problem hiding this comment.
Not really sure what is best to do here. Vale has a section in the docs of file formats https://vale.sh/docs/formats/front-matter, we don't even need to have one (although some features won't work if we don't). Ideally .twee would be close to one of them, but I'm not sure if it is?
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR integrates Vale for linting prose by adding a dedicated configuration, updating CI, and correcting a few style issues in existing story files.
- Introduces a new
.vale.inito configure Vale, proselint, and write-good rules. - Adds a CI step in
.github/workflows/linting.yamlto run Vale. - Cleans up redundant or awkward prose in
choose-a-database.twee.
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| story/choose-a-database.twee | Streamlined repeated sentences and improved phrasing. |
| .vale.ini | New Vale configuration: styles path, packages, disables. |
| .github/workflows/linting.yaml | Added Vale linting GitHub Action step. |
Comments suppressed due to low confidence (2)
.vale.ini:1
- [nitpick] Add a comment at the top of .vale.ini to explain the purpose of this configuration and link to Vale documentation, which will help future maintainers understand and update these settings.
StylesPath = .github/styles
story/choose-a-database.twee:71
- [nitpick] This description appears in multiple passages (explore-yes and text-no); consider extracting this repeated prose into a reusable passage or macro to reduce duplication and ease future updates.
A friendly looking elephant is drinking, and a dolphin pops its head above the water.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
In this PR I add vale similarly to paddyroddy/talks#80, paddyroddy/talks#82, UCL-ARC/python-tooling#541. See this blog post for an explanation of what it is https://www.datadoghq.com/blog/engineering/how-we-use-vale-to-improve-our-documentation-editing-process. I used this extensively during my PhD https://github.com/paddyroddy/phd-thesis/blob/main/.vale.ini. I recently gave a talk about this in the Collaboration Hour, slides here: https://paddyroddy.github.io/talks/linting-prose-with-vale.
I have also fixed the few cases with the limited rules I've selected.