Skip to content

H-6479: markdownlint ignore Cursor plan documents #8733

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.

Sign up for GitHub

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

Open
vilkinsons wants to merge 2 commits into
base: main
Choose a base branch
from
+7 −2
Open

H-6479: markdownlint ignore Cursor plan documents #8733

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
23ab161
semtype: update README
vilkinsons May 18, 2026
55cdbd5
markdownlint ignore Cursor plans
vilkinsons May 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .markdownlint-cli2.jsonc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@
"target/**",
"**/_temp/**",
"**/_ai/**",
"**/.cursor/plans/**",
"libs/@hashintel/ds-components/**",
"libs/@hashintel/ds-helpers/**"
]
Expand Down
8 changes: 6 additions & 2 deletions libs/@blockprotocol/type-system/rust/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
# Block Protocol Type System
# SemType (Block Protocol Type System)
Copy link
Copy Markdown

@augmentcode augmentcode Bot May 19, 2026 •
edited
Loading

Choose a reason for hiding this comment

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

PR template/process note: the PR description has every “publishable library/docs/turbo graph” checkbox ticked, which can be misleading for release/docs checks. Consider leaving only the applicable option(s) checked and removing the rest per the template instructions.

Severity: low

Fix This in Augment

🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage.


This crate implements the Block Protocol type system in Rust. It provides the foundation for defining, validating, and working with typed data in the HASH ecosystem. For details on the type system design, see the [Block Protocol Type System RFC](https://github.com/blockprotocol/blockprotocol/blob/main/rfcs/text/0352-graph-type-system.md).
This crate implements the SemType specification in Rust. It provides the foundation for defining, validating, and working with typed data in the HASH ecosystem.

**The public, canonical specification of the type system is published at [semtype.org/spec](https://semtype.org/spec).** This Rust crate is the reference implementation; the spec is kept in sync with it by hand, so changes to the type system here should be reflected at `semtype.org/spec`.

The corresponding TypeScript implementation can be found in the [`@blockprotocol/type-system`](../typescript) package. This crate is used to generate the TypeScript typings from the Rust implementation.

The predecessor to SemType was the "Block Protocol type system". For details on its (now deprecated) design, see the original [Block Protocol Type System RFC](https://github.com/blockprotocol/blockprotocol/blob/main/rfcs/text/0352-graph-type-system.md).

## Overview

The Block Protocol Type System defines a structured approach to typing data. It enables:
Copy link
Copy Markdown

@augmentcode augmentcode Bot May 19, 2026 •
edited
Loading

Choose a reason for hiding this comment

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

Now that the README introduces SemType, this line still says “The Block Protocol Type System defines…”, which reads inconsistent. Consider updating it to “SemType” (or just “the type system”) to avoid mixed terminology.

Severity: low

Fix This in Augment

🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage.

Comment on lines +9 to 13
Copy link
Copy Markdown
Contributor

@graphite-app graphite-app Bot May 19, 2026

Choose a reason for hiding this comment

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

Inconsistency in rebranding: The unchanged line 13 still refers to "The Block Protocol Type System" in the Overview section, but the PR rebrand this to "SemType" (with Block Protocol being the predecessor). This creates confusing documentation where:

  • Line 1 says it's now "SemType"
  • Line 9 says Block Protocol is the "predecessor"
  • But line 13 still describes it as "The Block Protocol Type System"

Fix: Update line 13 to reflect the new branding:

SemType defines a structured approach to typing data. It enables:
Suggested change
The predecessor to SemType was the "Block Protocol type system". For details on its (now deprecated) design, see the original [Block Protocol Type System RFC](https://github.com/blockprotocol/blockprotocol/blob/main/rfcs/text/0352-graph-type-system.md).
## Overview
The Block Protocol Type System defines a structured approach to typing data. It enables:
The predecessor to SemType was the "Block Protocol type system". For details on its (now deprecated) design, see the original [Block Protocol Type System RFC](https://github.com/blockprotocol/blockprotocol/blob/main/rfcs/text/0352-graph-type-system.md).
## Overview
SemType defines a structured approach to typing data. It enables:

Spotted by Graphite

Fix in Graphite

Is this helpful? React 👍 or 👎 to let us know.

Expand Down
Loading