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

Dawn/vale config #32

Merged
merged 15 commits into from
Aug 23, 2024
Merged

Dawn/vale config #32

merged 15 commits into from
Aug 23, 2024

Conversation

dawnkelly09
Copy link
Contributor

@dawnkelly09 dawnkelly09 commented Aug 22, 2024

This PR:

  • adds files for Vale configuration
  • adds files for GH Actions workflow related to Vale

Usage: Writers simply need to ensure they are using the updated main branch and then continue working with their documents as usual.

Scroll through the conversation to see examples of flagged errors.

@dawnkelly09 dawnkelly09 marked this pull request as draft August 22, 2024 18:07
docs/test.md Outdated

### Checking Logs

To check the nodes’ logs, you can use the provided command listed by the output as 'Log Cmd'. For instance, to check the logs of the `alice` node, you can open a new terminal and run the following command:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Cmd'?

docs/test.md Outdated

### Checking Logs

To check the nodes’ logs, you can use the provided command listed by the output as 'Log Cmd'. For instance, to check the logs of the `alice` node, you can open a new terminal and run the following command:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Papermoon.CustomDictionary] Did you really mean 'Cmd'?

docs/test.md Outdated
This test scenario checks to verify the following:

- the nodes are running
- the parachain with ID 100 is registered within a certain timeframe (255 seconds in this example)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'timeframe'?

docs/test.md Outdated
This test scenario checks to verify the following:

- the nodes are running
- the parachain with ID 100 is registered within a certain timeframe (255 seconds in this example)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Papermoon.CustomDictionary] Did you really mean 'timeframe'?

docs/test.md Outdated

- the nodes are running
- the parachain with ID 100 is registered within a certain timeframe (255 seconds in this example)
- the parachain block height is at least a certain number within a timeframe (in this case, 10 within 255 seconds)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'timeframe'?

docs/test.md Outdated

- the nodes are running
- the parachain with ID 100 is registered within a certain timeframe (255 seconds in this example)
- the parachain block height is at least a certain number within a timeframe (in this case, 10 within 255 seconds)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Papermoon.CustomDictionary] Did you really mean 'timeframe'?

@dawnkelly09 dawnkelly09 marked this pull request as ready for review August 22, 2024 18:28
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
id: get-modified-files
run: |
changed_files=$(gh pr diff --name-only ${{ github.event.pull_request.number }} | grep '\.md$' || true)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@0xLucca, just reviewing this line, maybe worth adding support to .pages files to avoid typos there as well:

changed_files=$(gh pr diff --name-only ${{ github.event.pull_request.number }} | grep '\.md$|.pages$' || true)

WDYT?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah would also like it to catch capitalization of page titles if possible

Copy link
Contributor

@eshaben eshaben left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great job! Super exciting! Had some questions

.github/styles/Papermoon/LinkTarget.yml Outdated Show resolved Hide resolved
.github/styles/Papermoon/Titlecase.yml Outdated Show resolved Hide resolved
.github/styles/Papermoon/Titlecase.yml Show resolved Hide resolved
.github/styles/Papermoon/WordSwapList.yml Outdated Show resolved Hide resolved
.github/styles/Papermoon/WordSwapList.yml Outdated Show resolved Hide resolved
.github/styles/Papermoon/WordSwapList.yml Outdated Show resolved Hide resolved
.github/styles/Papermoon/WordSwapList.yml Outdated Show resolved Hide resolved
.github/styles/config/vocabularies/Polkadot/accept.txt Outdated Show resolved Hide resolved
docs/dev-tools/chopsticks/overview.md Outdated Show resolved Hide resolved
@dawnkelly09 dawnkelly09 requested a review from eshaben August 23, 2024 13:30
@dawnkelly09
Copy link
Contributor Author

@eshaben I think I addressed all the comments, etc. Please let me know if you have more thoughts or requests for Vale setup. I am collecting a list of things we want it to do that aren't in place yet.

Copy link
Contributor

@eshaben eshaben left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! On the condition we circle back and address this comment in a future PR: #32 (comment)

@eshaben eshaben merged commit b9c24f9 into main Aug 23, 2024
1 check passed
@eshaben eshaben deleted the dawn/vale-config branch August 23, 2024 17:28
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.

4 participants