Documentation for ERSys 1.0.0-rc.1 (MVP)#3
Merged
gkostkowski merged 39 commits intoOP-TED:developfrom Apr 22, 2026
Merged
Conversation
Update AnnexeB use cases (ucb11-22, ucw1-5), AnnexeC ADRs (adra1-3, adrb1, adrc2, adrd2, adrg1-2), and architecture pages (core-capabilities, decisions, dependency inventory, deployment, introduction, scope, e2e, spines) with improvements and clarifications. Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
…corrections - Add Capabilities, Workflow, Top Application Bar, and UI Overview sections across overview, decisions, and history pages - Restructure decisions page into Decision List / Decision Area / Actions subsections - Add WARNING and NOTE admonitions for curation actions - Add application-bar.png and decision-area.png - Fix typos (Cener, Revieved), grammar, broken cross-reference, and punctuation inconsistencies across all four UserGuide pages
feat: add user guide for curation app
…delines Introduces the ERE Developer Guide page covering prerequisites, integration checklist, request handling lifecycle, data model, entity types, error handling, rebuild notifications, scoring conventions, and future considerations. Updates nav and index to include the new ERE section. Removes 'canonical entity type (CET)' terminology from the glossary in favour of plain 'entity type'.
…tions Adds the Basic ERE Reference Implementation page and wires it into the nav and index. Updates serve-docs port to 8088. Refines wording in the contract and architecture introductions to narrow serialisation format examples to RDF and to confirm Redis as the chosen messaging infrastructure.
Rewrites the Overview section with a conceptual description of the online clustering algorithm. Adds a scope and intended-audience paragraph at the top. Replaces the Architecture at a Glance section with a concise Tech Stack and Design section moved before See Also. Removes redundant "Supported." prefix from feature-support table rows. Downgrades the [IMPORTANT] admonition to [NOTE].
- Add "Changing a User's Password" section to admin guide - Add Entity Type filter to decisions filter bar - Add Confirmation Preferences section with skip-confirmation toggles - Update screenshots for admin edit user, filter bar, and decisions page
The ERS-ERE contract's resolution response section lacked any statement about candidates ordering. ERS always selects candidates[0] as the primary resolution outcome, so the ordering is normative. Added three sentences mandating that the list must have at least one entry and that the first entry must be the ERE's top proposed cluster assignment.
…guide docs(ERE): ERE developer guide, reference impl page, and doc corrections
…pp-guide docs: update curation user guide with new admin and decisions features
docs(ERE): add Basic ERE reference implementation page
…esponses Added a normative subsection clarifying that when ERE creates a new singleton cluster (no equivalent found), it shall return confidence_score and similarity_score of 0.0, and that ERS shall accept this as a valid outcome rather than a resolution failure.
…g Started stub - Restructured nav.adoc: grouped ERS (Architecture, Use Cases, API Reference) and ERE (Contract, Developer Guide, Basic ERE) sections; moved Glossary to top level; removed Annexe labels; added Getting Started entry - Rewrote index.adoc: added Introduction and ERSys Overview sections with component descriptions; replaced flat table with per-section tables - Renamed site title from "Service" to "System" across antora.yml, antora-playbook.yml, and antora-playbook.local.yml - Created GettingStarted.adoc stub (local stack setup guide)
docs: update documentation structure, home page, and ERS-ERE contract
chore: add CHANGELOG.md for 1.0.0-rc.1
costezki
previously approved these changes
Apr 22, 2026
chore(docs): update URLs to point out to the upstream repo
costezki
approved these changes
Apr 22, 2026
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
3 participants
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.
Scope: