Verification Status¶
Technical confidence is stronger when the type of verification is explicit. This project does not treat “the site builds” as proof that every claim and code fragment is correct.
Current verification levels¶
| Area | Verification performed | Remaining limitation |
|---|---|---|
| Navigation and local links | Automated validation across every Markdown page | External URLs can change independently |
| MkDocs rendering | Strict build with the pinned documentation toolchain | Client-side visual regression is not automated |
| Core search, sorting, BFS, and topological examples | Compiled and executed with deterministic generated tests | Tests are evidence, not formal proofs |
| C++ language examples | Compiled as C++20 with strict diagnostics and executed | Documentation snippets outside the executable example remain illustrative |
| Algorithm explanations | Manual contract, invariant, and complexity review | Not every algorithm has a machine-checked proof |
| Java language and concurrency | Manual review against language/API contracts and established references | Most isolated snippets are not compiled as one application |
| Spring and Spring Boot | Manual review against current official reference documentation | Illustrative snippets are not yet assembled into a runnable sample service |
| Practical engineering techniques | Cross-topic review plus current Spring, Hibernate, and Micrometer references where version-sensitive | Illustrative Java and SQL snippets are not one executable application |
| Privacy | Automated common-secret patterns plus editorial review | No detector can guarantee absence of every sensitive inference |
Meaning of code labels¶
- Executable example: stored under
examples/, compiled, and exercised by the quality workflow. - Java snippet: intended to be valid within the imports and enclosing type implied by the page, but may not have an independent build target.
- Pseudocode: language-neutral explanation; not intended for compilation.
- Conceptual configuration: demonstrates a contract or design decision and must be checked against the dependency version used by a real application.
Review rule¶
A page should not claim a stronger verification level than it has. Version- sensitive framework material links to official documentation. Future work can promote selected Spring examples to a runnable reference application with integration tests, migrations, security tests, and observability assertions.