chore: professionalize repo + add SD stress bench + first benchmark results#1
Merged
Merged
Conversation
Owner
Author
TL;DR for reviewersScope: documentation, CI tooling, packaging. No source files in Diff stats: Verification:
File moves (old → new)Community/governance:
Internal/process artifacts:
Suggested review pathIf you're short on time, review in this order:
Out of scope (intentionally deferred)
|
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.
This PR contains documentation, CI tooling, and packaging changes only.
No source files under
src/,include/,port/, or the existingtests/suite were modified. Public API and build targets are unchanged. The only
new code is non-blocking fuzzing scaffolding under
tests/fuzz/.What changed
marketing-style link farms).
documents moved to
docs/internal/. Single docs index added atdocs/README.md.loxdb(MIT, this repo) vs plannedloxdb_pro(commercial)boundary documented in
docs/EDITIONS.md.docs/BENCHMARKS.mdforESP32-S3 N16R8 results (placeholders only; no invented numbers).
ci-coverage-linuxpreset and coverage job (lcov artifact).library.jsonlibrary.properties(architectures=esp32)find_package(loxdb)config withloxdb::loxdbnamespaced target.What moved
.github/(CODE_OF_CONDUCT, CONTRIBUTING,SECURITY, SUPPORT).
docs/internal/.ROOT_SPEC_CORE_VS_PRO.md,LOXDB_PRO_BACKLOG.md)→
docs/internal/after distillation intodocs/EDITIONS.md.What was added
docs/TEST_SUITE_SIZE.mddocumenting the 504 microtest cases across48 test files (+1 C++ wrapper test), organized into the existing
CTest registrations.
docs/EDITIONS.md,docs/BENCHMARKS.md,docs/PROFILES.md,docs/SAFETY_NOTES.md,docs/README.md.docs/internal/MAINTAINER_TODO.mdcovering repo settings checklistand future CI roadmap (HIL / QEMU lane).
tests/fuzz/scaffolding + minimal WAL parser harness(scaffolding only — not yet proven fuzz coverage).
library.json,library.properties,cmake/loxdbConfig.cmake.in.Scope expansion during PR
In addition to the original cleanup, this PR also adds:
bench/loxdb_esp32_s3_sd_stress_bench/with admission preflight, fallback ladder, and reinit support
docs/results/(run on 2026-05-11, commit 4d1fd65)
docs/SD_STRESS_BENCH.mddocumenting the bench harnessdocs/social-preview-1280x640.pngWhat requires maintainer action
See
docs/internal/MAINTAINER_TODO.mdfor the items requiring repo adminaccess (GitHub Wiki disable, topics, description, social preview, releases
notes housekeeping, registry publication when ready).
Verification
broken_local_links_excl_wiki=0MAINTAINER_AUDIT.mdis intentionally not part of this PR(working document only; dropped via rebase before push).