Skip to content

docs(readme): reconcile the README with LESdylan's Osionos page - #187

Merged
vjan-nie merged 18 commits into
developfrom
docs/readme-reconcile
Nov 5, 2026
Merged

vjan-nie merged 18 commits into
developfrom
docs/readme-reconcile

Conversation

@vjan-nie

@vjan-nie vjan-nie commented Nov 5, 2026 •

Copy link
Copy Markdown
Contributor

One README for the project: LESdylan's Osionos page becomes the README, and where his page and ours disagree, his wins.

Why

The repository README (merged in #182 / #184) named the project Prismatica and graded 19 modules for 30 points. LESdylan's osionos page names it Osionos and claims 10 modules for 16 points. Two READMEs that disagree cannot both be defended. His page uses osionos-only syntax (:::columns, [b], > [!info], osidb embeds) that GitHub shows as raw text, so it is rewritten here in plain GitHub markdown.

What changed

  • Name: the project is Osionos. prismatica now names only the public landing (apps/opposite-osiris).
  • Structure and wording: his sections, in his order, with his emoji headings, tables and text.
  • Modules: his 10 modules and 16 points (6 Majors, 4 Minors) replace our 19 graded rows.
  • Team: his role table (one owner per role).
  • Licence: the License section follows the LICENSE he added in 0978f11. It no longer says there is no root licence.
  • Vadim's lines: "Docker infrastructure" is removed. The editable block logic in osionos src/features/block-editor is claimed instead (evidence below).
  • Wiki: four wiki links follow the renamed headings (#modules, #features-list).

Added from ours: only what his page lacks and does not contradict

Addition Source in our README (develop b8e1545d)
Naming note for the track-binocle infrastructure identifiers header note
Runbook and make help pointers, local CA trust steps, checks table, demo account, optional integrations, development bring-up Instructions
Logins and areas table; former members and the rstancu acknowledgement Team Information
Issue counts, review rulesets, one-word-subject check Project Management
How make all applies the model migrations; has_permission and the Rust ABAC evaluator Database Schema
Per-feature table with commit counts (his is an osidb embed GitHub cannot render) Features List
Core files, tests → CI job and docs for the 8 of his modules our table covered (W12 and W13 have none) Modules
Per-member lines and the who-committed-where table (wiki pages link to it) Individual Contributions
AI tools the repositories record; the 2026-11-04 Co-authored-by trailer rewrite How AI was used
GoTrue reference References
Loopback-only whiteboard, narrow-by-design note, link to the known security weaknesses Known limitations
Table of contents, Further documentation ours

Left out of his page

  • His tracker-tab instructions ("tick ✓ on the Checklist tab", "the 🏆 Claimed tab", "Open the 🎯 Modules tab"), the "Key commits" embed, and the "To fill before the evaluation" section (an image on a private tailnet host and a whiteboard embed). None of them exists on GitHub.

Dropped from ours because his page contradicts it

  • Modules: Public API, advanced permissions, organisation, health and backups, GDPR, 2FA, both modules of choice, RAG, moderation and voice. Our A/B grades are dropped too.
  • Project management: "no milestone exists", the sprint and stand-up rhythm, and ZAP "on every pull request" (it runs only on workflow_dispatch, as CodeRabbit noted on chore: promote develop to main (README rewrite) #186).
  • Roles: our role column had two tech leads and a QA lead; his table has one tech lead.

Contradictions to settle (not resolved here)

  1. 52 vs 16 points. His summary tile says "52 points, 10 modules claimed". His Modules section says "10 modules, 16 points". The README keeps both as he wrote them. Which is right?
  2. 2FA. We claimed it (B). His page warns that enrolling locks the account out, because the sign-in code prompt is missing.
  3. GDPR deletion. We claimed it (B). His page says the Privacy Policy promises a deletion the code never performs.
  4. Public API. We graded it A, with OpenAPI docs served at /docs/. His page lists PUT/DELETE on personal tokens and serving the docs as missing work. The feature row no longer claims the docs are served.
  5. Commit share. His note says dlesieur holds "about 88%" of commits. Our earlier count was 86% of 8,571 human commits. The README keeps his figure.
  6. Disk. His prerequisites give 30 GB of disk and 23 GB for images and cache. Ours said no minimum was measured. His figures match the runbook row that 394280d removed ("Disk ≥ 30 GB free … images 13.5 GB + build cache 9.5 GB + volumes 1.4 GB, measured 2026-10-01", git show 394280db^:wiki/runbooks/fresh-machine.md, line 13). His figures are kept, and CodeRabbit asked on chore: promote develop to main (README rewrite) #186 for that row to be restored.

Evidence

  • Vadim's block-editor claim, at main's osionos pin 735c40fd: 42 of 254 non-merge commits on src/features/block-editor (vjan-nie 30 + 3, Vado 9). Command: git -C apps/osionos/app log --no-merges --format='%an <%ae>' 735c40fd -- src/features/block-editor | sort | uniq -c. Files touched most: ui/BlockEditor.tsx (18), model/usePlaygroundBlockEditor.ts (15), ui/PlaygroundPageEditor.tsx (9), ui/BlockContextMenu.tsx (6). Caveat: 3 of the 42 are second-brain gate commits that only touch the folder.
  • markdownlint (markdownlint-cli2@0.18, default config, node:22-alpine), counts on develop → this branch: MD013 151 → 52, MD032 2 → 0, MD041 1 → 1. No rule fires that did not fire on develop.
  • Links: 51 relative links in the README, plus wiki links into it, all resolve (files and github-slugger anchors). Caveat: github-slugger models GitHub's anchor rules but is not GitHub's renderer. The ⚠️ heading's anchor keeps U+FE0F.
  • Points re-add from the module table: 10 modules, 16 points, 6 Majors, 4 Minors.

LESdylan's answers 2026-11-05: applied (1–4)

  1. Points: the summary now says 16 points, 10 modules (6 Majors, 4 Minors). "52" is gone (f76bda8d).
  2. Tracking: "GitHub Issues and labels track the work". All seven project repositories have 0 milestones (gh api repos/Univers42/<repo>/milestones?state=all) (7c59ee7d).
  3. Commit share: one measured figure, stated once. dlesieur holds 86% (5,895 of 6,876 non-merge member commits) at groot main 948487ee's pins, counted with wiki/project/contributions-method.md (cd7fe809). The who-committed-where table, counted at 0bef3cb3, gives the same 86%.
  4. Licence scope: LICENSE and the README's License section now apply the licence to this repository's own files. Each git submodule in .gitmodules keeps its own licence: grobase AGPL-3.0, monkey-bot MIT (0df762ba). The scope names .gitmodules instead of apps/*, vendor/* because groot owns files under apps/ too (apps/README.md, apps/osionos-desktop/), and .claude is a submodule as well.

Checks re-run in Docker: no markdownlint rule fires that does not fire on develop (MD013 151 → 52, MD032 2 → 0, MD041 1 → 1). 53 relative links, 0 broken. Points re-add: 10 modules, 16 points, 6 Majors, 4 Minors.

LESdylan's README (his osionos page) is the team's version; where the two
disagree his wins. The project is Osionos; prismatica stays only as the name
of the public landing. His summary tiles are kept as written, including
"52 points", which disagrees with the 16 points his own Modules section
gives; the PR flags it rather than picking one. Added from ours, which his
page lacks: the naming note on the track-binocle infrastructure identifiers.
…is page lacks

His commands check out the latest tag on main, which is what
scripts/verify/fresh-bringup.sh builds, and his prerequisites give a disk
size. Added from ours, which his page lacks: the runbook and make help
pointers, the local CA trust steps, the checks table, the demo account,
the optional integrations and the development bring-up.
… block editor

His table gives one owner per role; our per-member role column disagreed
with it (two tech leads and a QA lead) and is dropped. Added from ours: a
logins and areas table, the former members and the rstancu
acknowledgement. Vadim's area drops Docker infrastructure and claims the
editable block logic in osionos src/features/block-editor.
Dropped from ours where it contradicts his: no milestones exist (his
page says milestones track the work), the sprint and stand-up rhythm, and
the claim that ZAP runs on every pull request (it is workflow_dispatch
only, as CodeRabbit noted on #186). Added from ours: the issue counts, the
review rulesets and the commit-subject check.
His table, reasons, diagram and table groups replace ours. Added from
ours: how make all applies the model migrations and which runner skips
the integer-id files, and that access rules are evaluated by
has_permission and the Rust ABAC evaluator.
His features list is an osionos database embed that GitHub cannot render,
so our per-feature table with commit counts fills it. The Public API row
no longer says the OpenAPI docs are served: his page lists serving them as
missing work.
…ence

His list replaces our 19 graded rows. Our core files, tests with their
CI job, and docs are kept for the 8 of his modules our table covered; W12
and W13 have none from us. Dropped: Public API, advanced permissions,
organisation, health and backups, GDPR, 2FA, both modules of choice, RAG,
moderation and voice. His tracker-tab instructions are left out because
the tracker does not exist on GitHub.
…tributions note

His contributions are a database embed GitHub cannot render; his note
and challenges are kept, and ours supply the per-member lines and the
who-committed-where table that wiki pages link to. Vadim's line drops
Docker infrastructure and claims the editable block logic: 42 of the 254
non-merge commits on osionos src/features/block-editor at main's pin
735c40fd, counted with git log --no-merges on that path.
… Osionos licence

The License section said there was no root LICENSE; LESdylan added the
Osionos Project License in 0978f11, and the section now follows its
wording. Added from ours: the AI tools the repositories record, the
2026-11-04 trailer rewrite, the GoTrue reference, the loopback-only
whiteboard, the narrow-by-design note, the security weaknesses link and
the further documentation list. His empty to-fill section is left out.
The emoji headings from his page change GitHub's anchors (#-description,
not #description).
The README now uses LESdylan's emoji headings, so #modules and
#features-list no longer resolve on GitHub.
markdownlint flagged the lone italic stack lines (MD036, three) and the
bare git@github.com (MD034); both were new against develop.
@vjan-nie
vjan-nie requested a review from LESdylan November 5, 2026 13:30
@coderabbitai

coderabbitai Bot commented Nov 5, 2026 •

Copy link
Copy Markdown
Contributor

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: ba53fd56-ef2d-45b2-aa48-ecf6b1d5a9e6

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
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

394280d removed it when #184 dropped the figures from the README for lack
of a source. The README now states 30 GB of disk and 23 GB for images and
cache again (LESdylan's page), and CodeRabbit flagged the gap on #186. The
figures come from c3a80d1: docker system df on the dev VM with the stack
running, 2026-10-01. That commit already noted they were not taken from a
clean build, so the row carries that caveat.
…thod

"the commit groot `main` pins" read as incomplete (CodeRabbit on #186,
contributions-method.md:9). It now reads "the commit that groot's `main`
pins".
…does

The summary tile said 52 points; the Modules section and the re-add of its
table give 10 modules, 6 Majors and 4 Minors, 16 points. LESdylan
confirmed 16 on 2026-11-05.
No project repository has a milestone: gh api repos/Univers42/<repo>/milestones?state=all
returns 0 for groot, osionos, grobase, prismatica, hydrawn, osionos-mail
and osionos-calendar (2026-11-05). LESdylan approved the change.
The note said "about 88%". Measured with the method in
wiki/project/contributions-method.md at groot main 948487e's pins (root,
osionos, grobase, opposite-osiris, hydrawn, mail, calendar, QA,
monkey-bot; non-merge, .mailmap applied, bots and AI-agent identities
left out): dlesieur 5,895 of 6,876 member commits, 85.7%, stated as 86%.
The who-committed-where table, counted at 0bef3cb, gives the same 86%
(5,878 of 6,837).
The licence claimed every file in the repository, including the git
submodules, which carry their own terms: apps/grobase is AGPL-3.0
(apps/grobase/LICENSE) and vendor/monkey-bot is MIT (CodeRabbit on #186,
LICENSE:11). LESdylan approved scoping it on 2026-11-05. The scope names
.gitmodules rather than apps/* and vendor/*, because groot owns files
under apps/ too (apps/README.md, apps/osionos-desktop/). The rest of his
wording is unchanged.
@vjan-nie

vjan-nie commented Nov 5, 2026

Copy link
Copy Markdown
Contributor Author

@LESdylan Your 4 answers are applied — ready for your approval.

@vjan-nie
vjan-nie merged commit 4bb457c into develop Nov 5, 2026
21 checks passed
@sonarqubecloud

sonarqubecloud Bot commented Nov 5, 2026

Copy link
Copy Markdown

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