Skip to content

docs: replace README with estate README.adoc + EXPLAINME.adoc pair, source wiki, and elaborate autolinks - #77

Merged
arena-ai-coding-agent[bot] merged 5 commits into
mainfrom
arena/01a0db67-metamanifold-webui
Sep 26, 2026
Merged

arena-ai-coding-agent[bot] merged 5 commits into
mainfrom
arena/01a0db67-metamanifold-webui

Conversation

@arena-ai-coding-agent

Copy link
Copy Markdown

Summary

Replaces README.md with the estate-standard README.adoc + EXPLAINME.adoc pair, sources the BerryWiki-format wiki in docs/wikis/ (synced live to MetaManifold-WebUI.wiki.git), and provides the full paste-ready specification for GitHub Settings → Autolink references in docs/integration/autolink-references.md.

Base check

  • Base is hyperpolymath/MetaManifold-WebUI:main (not the upstream
    parent; application changes go to JoshuaJewell/MetaManifold-WebUI)

Changes

  • README.adoc (README.md retired):
    • Authored in AsciiDoc per standards:docs/README-EXPLAINME-STANDARD.adoc.
    • Presents the three-layer visual design progression: 1) Base R/Python design (cutadapt -> DADA2 / Swarm lanes), 2) JoshuaJewell's MetaManifold augmentation (orchestrator + DuckDB + WebUI), 3) This fork's honest estimation, exact arithmetic, scaling offsets, and epistemic status.
    • Clearly distinguishes implemented vs planned features.
    • Quick start pointing directly to EXPLAINME.adoc.
    • Third-party tools table and acknowledgements migrated into NOTICE.
  • EXPLAINME.adoc (new):
    • Technical justification and claim-to-implementation map covering every README claim with exact citations, implementation notes, and caveats.
    • Dogfooding table across CLI, web UI, pipeline orchestration, and analysis layers.
    • Known gaps marked as explicit [CAUTION] blocks (statistical review outstanding, missing UI screenshots, skips in react-router/types).
    • Cross-references the wiki deep dives rather than ballooning into an unreadable file.
  • docs/wikis/ (32 files, sourced per RSR convention):
    • Formatted per metadatastician/berrywiki with UUIDv7 metadata headers, hierarchy (parent), positions, and tags.
    • Three comprehensive audience sections:
      • Users: Install, First Study, Configuration Reference, Exploring Results, Analysis and Statistics, with dedicated tracks for Academics (reproducibility, citations, small-n honesty) and Lab Professionals (QC gates, database maintenance, throughput).
      • Maintainers: Operator Track (deployment, DuckDB ops, R runtime) and Steward Track (estate alignment, triage, releases).
      • Developers: Architecture Tour, Type System, Statistics Internals, Extending the Pipeline, Testing & Benchmarks, REST API.
    • Seven Deep Dives: Design Progression, Type Theory Meets Statistics, Exact Arithmetic, Maximum Likelihood & Refusals, Compositional Statistics & Offsets, Epistemic Status & Receipts, Advanced Functionality.
    • Status & Roadmap board marking all features IN PLACE / PARTIAL / COMING / BLOCKED.
    • All wiki pages carry SPDX-License-Identifier: CC-BY-SA-4.0 headers; wiki is live at https://github.com/hyperpolymath/MetaManifold-WebUI/wiki.
  • docs/integration/autolink-references.md (new):
    • 22 paste-ready prefix -> URL template entries across 4 tiers (lineage/estate, upstream pipeline tools, toolchain, registries).
    • Reserved/omitted identifiers documented with rationale.
  • NOTICE & CONTRIBUTING.md:
    • NOTICE updated with third-party tools table and academic acknowledgements.
    • CONTRIBUTING.md quick-start updated to reference README.adoc.
    • CHANGELOG.md updated under [Unreleased].

Engineering checklist

Required

  • Conventional commit subjects (see CONTRIBUTING.md)
  • New source files carry the correct SPDX header (NOTICE explains the authorship rule)
  • scripts/check-spdx.sh passes (324 files covered)
  • scripts/check-format.sh passes (374 files checked)
  • scripts/check-blob-hygiene.sh passes (0 violations)
  • No secrets, credentials, .env, or sequencing data included
  • No application-logic changes hidden inside alignment/tooling PRs

As applicable

  • CHANGELOG.md updated for user/developer-visible changes
  • AsciiDoc delimiter balance verified (README.adoc, EXPLAINME.adoc)
  • Wiki deployed and live on MetaManifold-WebUI.wiki.git

Testing

Verified locally:

  • scripts/check-spdx.sh: OK (324 files covered)
  • scripts/check-format.sh: OK (374 files checked)
  • scripts/check-blob-hygiene.sh: OK (0 violations)
  • AsciiDoc block delimiters (====, ----, ____) all balanced even counts.
  • BerryWiki metadata parent graph validated: 0 dangling parents, all UUIDs unique.
  • Live wiki HTTP 200 responses verified on GitHub for Home, Status and Roadmap, and Deep Dives.

hyperpolymath and others added 4 commits September 26, 2026 15:16
…andards

Produced the full autolink reference specification in docs/integration/
with 22 paste-ready prefix->URL entries across 4 tiers (lineage/estate,
upstream pipeline tools, toolchain, registries), reasoned reserved/omitted
cases (CVE, ADR slugs), and a verification checklist for GitHub Settings.

Co-authored-by: arena-agent <297053741+arena-agent@users.noreply.github.com>
Authored 32 wiki pages (31 content pages + _Sidebar.md + docs/wikis/README.md)
in the metadatastician/berrywiki format (hidden UUIDv7 metadata block,
hierarchical parent pointers, positions, tags) covering:
- Users section (Install, First Study, Config Ref, Results, Stats,
  For Academics, For Lab Professionals, Troubleshooting)
- Maintainers section (Operator Track, Steward Track, Releases, Compliance)
- Developers section (Architecture, Type System, Stats Internals, Extending,
  Testing & Benchmarks, REST API)
- Deep Dives (Design Progression, Type Theory Meets Statistics,
  Exact Arithmetic, Maximum Likelihood & Refusals, Compositional Statistics,
  Epistemic Status, Advanced Functionality)
- Status & Roadmap (IN PLACE / PARTIAL / COMING / BLOCKED board)

Co-authored-by: arena-agent <297053741+arena-agent@users.noreply.github.com>
…pair

- README.adoc: three-layer visual design progression (base R/Python DADA2,
  JoshuaJewell MetaManifold augmentation, fork honest estimation/typing),
  shipped vs planned features, quick start pointing to EXPLAINME, clean
  repository layout, and licensing.
- EXPLAINME.adoc: claim->implementation->caveat map covering every README
  claim, dogfooding table, known gaps as CAUTION blocks, and evidence index;
  cross-references the wiki deep dives to stay lean.
- README.md: removed (replaced by README.adoc per estate standard).
- NOTICE: received third-party tools table and acknowledgements/lineage from
  old README.md; self-contained.
- CONTRIBUTING.md: updated reference to README.adoc § Quick start.
- CHANGELOG.md: recorded the documentation additions under [Unreleased].

Co-authored-by: arena-agent <297053741+arena-agent@users.noreply.github.com>
…sources

Satisfies scripts/check-spdx.sh policy while preserving BerryWiki metadata
block validity (metadata field preserved verbatim as unknown key per spec).

Co-authored-by: arena-agent <297053741+arena-agent@users.noreply.github.com>
@coderabbitai

coderabbitai Bot commented Sep 26, 2026 •

Copy link
Copy Markdown

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Advanced

Run ID: 8141314a-8714-46c1-8de5-0300514bb754

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

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.

Co-authored-by: arena-agent <297053741+arena-agent@users.noreply.github.com>
@arena-ai-coding-agent
arena-ai-coding-agent Bot merged commit 1da82dd into main Sep 26, 2026
4 of 6 checks passed
@arena-ai-coding-agent
arena-ai-coding-agent Bot deleted the arena/01a0db67-metamanifold-webui branch September 26, 2026 15:25
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