Skip to content

Commit

Permalink
Merge branch 'main' into gai/remove-filtering-doc
Browse files Browse the repository at this point in the history
  • Loading branch information
michaelstaib authored May 27, 2024
2 parents c86958e + ac05a49 commit 5e45479
Show file tree
Hide file tree
Showing 185 changed files with 4,236 additions and 13,559 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ jobs:
run: npm install -g cspell

- name: run cspell
run: cspell --config ./cSpell.json "website/src/**/*.md" --no-progress --no-cache
run: cspell --config ./cspell.json "website/src/**/*.md" --no-progress --no-cache

linting:
name: "Markdown linting"
Expand Down
3 changes: 2 additions & 1 deletion .vscode/extensions.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
"EditorConfig.EditorConfig",
"k--kato.docomment",
"dbaeumer.vscode-eslint",
"josefpihrt-vscode.roslynator"
"josefpihrt-vscode.roslynator",
"streetsidesoftware.code-spell-checker"
]
}
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,11 +75,11 @@ There are other available commands too. As set up in the [.build](./.build/) dir

## How to Check the docs

We use [Markdownlint](https://github.com/DavidAnson/markdownlint) to check markdown formatting and [cSpell](https://cspell.org) for spelling. We have GitHub actions to check these for PRs, but if you'd like to check locally, you can:
We use [Markdownlint](https://github.com/DavidAnson/markdownlint) to check markdown formatting and [CSpell](https://cspell.org) for spelling. We have GitHub actions to check these for PRs, but if you'd like to check locally, you can:

- Install cSpell: `npm install -g cspell`
- Install CSpell: `npm install --global cspell`
- Install the markdownlint CLI: `npm install -g markdownlint-cli`.
- For spellcheck, run `cspell --config ./cSpell.json "website/src/**/*.md" --no-progress`
- For spellcheck, run `cspell --config ./cspell.json "website/src/**/*.md" --no-progress`
- For markdown linting, run `markdownlint "./website/src/**/*.md" --disable MD013`

## Code of conduct
Expand Down
107 changes: 0 additions & 107 deletions cSpell.json

This file was deleted.

16 changes: 16 additions & 0 deletions cspell.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
{
"$schema": "https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json",
"version": "0.2",
"language": "en",
"dictionaries": ["csharp", "custom"],
"dictionaryDefinitions": [
{
"name": "custom",
"path": "./dictionary.txt"
}
],
"ignoreRegExpList": [
"featuredVideoId:(.*)", // video hash
"videoId=\"(.*)\"" // video hash
]
}
88 changes: 88 additions & 0 deletions dictionary.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
Andi
aspnetcore
automagically
autonumber
Badurina
bananacakepop
BCPROCKS
blazor
blazorwasm
BSON
cacheable
CCPA
chillicream
Contoso
CQRS
dataloaders
decompile
enisdenjo
entityframework
FIPS
foos
fricking
Giroux
GraphiQL
graphqlconfig
graphqlrc
graphyne
greendonut
Hasura
hotchocolate
Kellner
Kydne
Linq
Marek
matchesBrics
mercurius
meros
ncontains
nendsWith
NEWHOPE
Newtonsoft
ngte
nintersects
nlte
Noda
Normen
noverlaps
Npgsql
nstartsWith
NSwag
ntouches
nwithin
oneof
OpenIddict
OWIN
pageable
PKCE
Postgraphile
preconfigured
protobuf
quox
quux
Rafi
reencode
relayjs
Rgba
runbooks
Senn
shoooe
Skywalker
snapshooter
Specwise
srid
Staib
starwars
strawberryshake
Structs
sublicensable
supergraph
Swashbuckle
Tengler
unpublish
URQL
vsix
websockets
winget
Wunder
xunit
6 changes: 6 additions & 0 deletions src/CookieCrumble/src/CookieCrumble/ISnapshotSegment.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
namespace CookieCrumble;

internal interface ISnapshotSegment
{
string? Name { get; }
}
Loading

0 comments on commit 5e45479

Please sign in to comment.