Skip to content

docs: add FAQ and JSON-LD schema - #1

Merged
cloudsealed merged 5 commits into
mainfrom
docs/faq
Oct 3, 2026
Merged

cloudsealed merged 5 commits into
mainfrom
docs/faq

Conversation

@cloudsealed

Copy link
Copy Markdown
Owner

Add FAQ section covering: what the lib does, vs ML.NET alone, .NET version, zero-allocation meaning, ASP.NET Core integration example.

Add JSON-LD FAQPage schema for LLM/search discoverability.

@github-actions

github-actions Bot commented Oct 3, 2026 •

Copy link
Copy Markdown

🏗️ predictive-ml-core — architecture risk audit

Analysis of 4 system(s) for Acme complete. Overall score (weighted by criticality): 67/100. 4 finding(s), 4 recommendation(s).

Overall score Systems Findings
67/100 4 4

Findings

System Severity Title
checkout-api HIGH Single point of failure: checkout-api System 'checkout-api' (criticality CRITICAL, type API) declares no redundancy. Assumption: the input schema exposes no redundancy field, so a single instance is assumed (worst case).
orders-db CRITICAL Single point of failure: orders-db System 'orders-db' (criticality CRITICAL, type DATABASE) declares no redundancy. Assumption: the input schema exposes no redundancy field, so a single instance is assumed (worst case).
orders-db MEDIUM Scalability gap: orders-db Insufficient scalability signal for 'orders-db' (no historicalMetrics — conditional risk, labeled as unknown risk).
payment-gateway HIGH Single point of failure: payment-gateway System 'payment-gateway' (criticality HIGH, type THIRD_PARTY_SERVICE) declares no redundancy. Assumption: the input schema exposes no redundancy field, so a single instance is assumed (worst case).

Top recommendations

  • Implement redundancy (checkout-api) — effort MEDIUM
  • Implement redundancy (orders-db) — effort HIGH
  • Improve scalability (orders-db) — effort MEDIUM
  • Implement redundancy (payment-gateway) — effort MEDIUM

Generated by Predictive-ML-Core — deterministic, auditable rule scoring, method in METHODOLOGY.md.

cloudsealed and others added 4 commits October 3, 2026 09:38
The example-usage workflow was pulling a pre-built image from Docker Hub,
which caused the PR comment to contain Portuguese text from the old build.
Building from the current checkout ensures the action always reflects the
latest source, including the English translation committed in ca8cd49.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Tests were asserting Portuguese finding titles/descriptions that were
translated in ca8cd49 — updated to match the English strings now in
ArchitectureAnalyzer.cs.

Dockerfile was missing -f net10.0 on dotnet publish, causing NETSDK1129
for multi-target projects.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
…files

Missed in ca8cd49: test data strings (category/title/description),
assertions checking for Portuguese finding titles, and block comments in
ApiEndpointTests, SeverityPredictionEngineTests, HtmlReportRendererTests,
WebhookNotifierTests, ScoreBreakdownTests, and ArchitectureAnalyzerTests.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
@cloudsealed
cloudsealed merged commit 599f9df into main Oct 3, 2026
2 checks passed
@cloudsealed
cloudsealed deleted the docs/faq branch October 3, 2026 16:20
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