Skip to content

The assurance case fits the site's rules: description, SEO row, Next block, long-form - #23

Merged
arpanghoshal merged 1 commit into
mainfrom
docs/assurance-case-fits
Sep 13, 2026
Merged

arpanghoshal merged 1 commit into
mainfrom
docs/assurance-case-fits

Conversation

@arpanghoshal

Copy link
Copy Markdown
Member

What this changes

#18 merged with four site-rule failures that lint.py, links.py and snippets.py do not cover and the pytest suite does; they surfaced on #22's run. Fixed here:

  • frontmatter description shortened to 155 characters or fewer;
  • a row in SEO.md with the page's definitional opener;
  • a closing ## Next block linking the threat model, verify guarantees, Get started and Why;
  • the page joins LONG_FORM in tests/test_docs_site.py, beside THREAT_MODEL and ARCHITECTURE, with the reason in a comment: it argues every requirement with its evidence and is read by criterion, not in one sitting. It is 1,816 words against the 900-word budget for pages read in one sitting.

tests/test_docs_site.py and tests/test_docs_seo.py pass for the page against the kernel's main; lint.py and links.py are clean.

🤖 Generated with Claude Code

…block, long-form

Four tests the page failed once it was on main: a description over 155
characters, no row in SEO.md, no closing Next block with the Why and Get
started links, and 1,816 words against a 900-word budget. The first three are
fixed on the page. For the fourth the page joins the long-form list beside
the threat model and the architecture: it argues every requirement with its
evidence and is read by criterion, not in one sitting.

Signed-off-by: arpan <contact@arpanghoshal.com>
@mintlify

mintlify Bot commented Sep 13, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
ctrlrun 🟢 Ready View Preview Sep 13, 2026, 10:52 PM

💡 Tip: Enable Automations to automatically generate PRs for you.

@coderabbitai

coderabbitai Bot commented Sep 13, 2026

Copy link
Copy Markdown

Warning

Review limit reached

Next included review available in 17 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Learn how review limits work.

Review configuration:

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: ba0cddb4-c63e-47ba-aa76-09047069471f

📥 Commits

Reviewing files that changed from the base of the PR and between fee0bb7 and 92ac5fe.

📒 Files selected for processing (3)
  • SEO.md
  • docs/security/assurance-case.mdx
  • tests/test_docs_site.py

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@arpanghoshal
arpanghoshal merged commit 42b3edd into main Sep 13, 2026
1 of 3 checks passed
@arpanghoshal
arpanghoshal deleted the docs/assurance-case-fits branch September 15, 2026 19:15
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.

1 participant