fix: docs audit Phase 1 — remove ghost APIs, fix stale versions, correct scoring model#26
Merged
fix: docs audit Phase 1 — remove ghost APIs, fix stale versions, correct scoring model#26
Conversation
✅ Documentation Build SuccessfulThe documentation build completed successfully and passed validation checks.
|
✅ Documentation Build SuccessfulThe documentation build completed successfully and passed validation checks.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Phase 1 of the documentation audit (DOCS-AUDIT-001). Every change verified against actual source code in capiscio-sdk-python, capiscio-core, and capiscio-server.
19 files changed across landing page, overview, getting-started, CLI reference, SDK reference, server reference, identity, trust, and scoring pages.
What was wrong
Ghost APIs (non-existent functions documented as working)
sign_request()/verify_request()— never existed as top-level SDK imports@guard.protectdecorator — doesn't exist onSimpleGuardguard.get_caller_identity(request)— doesn't existSimpleGuard(min_trust_level=2)— no such constructor parametercapiscio identity resolve— command doesn't existcapiscio key did— command doesn't existcapiscio version— not a subcommand; use--versionflagSecurityConfig.production(trusted_issuers=..., min_trust_level=...)— not accepted paramsCapiscioMiddlewareimported from root package — lives incapiscio_sdk.integrations.fastapiWrong CLI flags
--ttlonbadge requestdocumented as duration (5m) — actually integer seconds (300)--methodonbadge dv create— actual flag is--challenge-type(http-01/dns-01)badge dv status/finalizetook positional[challenge-id]— actual flag is--order-id--ca-urlonbadge keep— actual flag is--cabadge request --level --domain— these flags don't exist onbadge requestWrong values
v0.1.0 (pre-release)→ v2.5.00.2.0→ 2.5.02.1.x→ 2.5.02.3.1→ 2.5.0cpsc_live_→sk_live_0.2.0→ 0.3.0 (matchescapiscio init)Wrong scoring model
60/20/15/5weighted categories — actual: penalty-based (start at 100, deduct per violation)40/25/20/15weighted categories +confidence multiplier(1.0x/0.6x/0.4x) — actual: discrete fixed scores (100/80/60/20/0 based on signature state)Missing SDK params
verify_badge()missingfail_openandstale_threshold_secondsparamsVerifyOptionsmissing same fieldsBadgeClaims.ialshown as not-implemented — it IS implementedBadgeClaimsmissinghas_key_bindingandconfirmation_keypropertiesVerification method
All changes verified by reading actual source code:
capiscio-sdk-python/capiscio_sdk/__init__.py,simple_guard.py,badge.py,config.py,integrations/fastapi.pycapiscio-core/cmd/capiscio/*.go(all Cobra command definitions and flag bindings)capiscio-server/internal/version/version.go,internal/api/router.go,internal/api/middleware.gocapiscio-core/pkg/scoring/compliance.go,trust.go,engine.goDocs build verified clean:
mkdocs buildsucceeds with no new warnings.