doc: update documentation for ontology-driven architecture - #401
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #401 +/- ##
==========================================
+ Coverage 99.75% 99.81% +0.05%
==========================================
Files 10 15 +5
Lines 1602 2107 +505
==========================================
+ Hits 1598 2103 +505
Misses 4 4 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Signed-off-by: Jessica Ikechukwu <Jessica.Ikechukwu@uwe.ac.uk>
…s well as improved the index.rst
jim-smith
reviewed
Aug 7, 2026
jim-smith
reviewed
Aug 7, 2026
jim-smith
reviewed
Aug 7, 2026
jim-smith
reviewed
Aug 7, 2026
jim-smith
reviewed
Aug 7, 2026
jim-smith
reviewed
Aug 7, 2026
jim-smith
reviewed
Aug 7, 2026
jim-smith
reviewed
Aug 7, 2026
jim-smith
reviewed
Aug 7, 2026
jim-smith
reviewed
Aug 7, 2026
jim-smith
reviewed
Aug 7, 2026
jim-smith
reviewed
Aug 7, 2026
Co-authored-by: Jim-smith <jim-smith@users.noreply.github.com> Signed-off-by: Jessica Ikechukwu <Jessica.Ikechukwu@uwe.ac.uk>
Co-authored-by: Jim-smith <jim-smith@users.noreply.github.com> Signed-off-by: Jessica Ikechukwu <Jessica.Ikechukwu@uwe.ac.uk>
Co-authored-by: Jim-smith <jim-smith@users.noreply.github.com> Signed-off-by: Jessica Ikechukwu <Jessica.Ikechukwu@uwe.ac.uk>
Co-authored-by: Jim-smith <jim-smith@users.noreply.github.com> Signed-off-by: Jessica Ikechukwu <Jessica.Ikechukwu@uwe.ac.uk>
jim-smith
requested changes
Aug 7, 2026
jim-smith
left a comment
Contributor
There was a problem hiding this comment.
a very few minor things to change/suggestions otherwise good to go. Much improved
Co-authored-by: Jim-smith <jim-smith@users.noreply.github.com> Signed-off-by: Jessica Ikechukwu <Jessica.Ikechukwu@uwe.ac.uk>
Clarify steps for adding methods to ACRO class and handling analyses. Signed-off-by: Jessica Ikechukwu <Jessica.Ikechukwu@uwe.ac.uk>
jim-smith
reviewed
Aug 11, 2026
jim-smith
reviewed
Aug 11, 2026
Co-authored-by: Jim-smith <jim-smith@users.noreply.github.com> Signed-off-by: Jessica Ikechukwu <Jessica.Ikechukwu@uwe.ac.uk>
jim-smith
reviewed
Aug 11, 2026
Co-authored-by: Jim-smith <jim-smith@users.noreply.github.com> Signed-off-by: Jessica Ikechukwu <Jessica.Ikechukwu@uwe.ac.uk>
Co-authored-by: Jim-smith <jim-smith@users.noreply.github.com> Signed-off-by: Jessica Ikechukwu <Jessica.Ikechukwu@uwe.ac.uk>
jim-smith
reviewed
Aug 11, 2026
Co-authored-by: Jim-smith <jim-smith@users.noreply.github.com> Signed-off-by: Jessica Ikechukwu <Jessica.Ikechukwu@uwe.ac.uk>
jim-smith
reviewed
Aug 11, 2026
Co-authored-by: Jim-smith <jim-smith@users.noreply.github.com> Signed-off-by: Jessica Ikechukwu <Jessica.Ikechukwu@uwe.ac.uk>
jim-smith
reviewed
Aug 11, 2026
jim-smith
requested changes
Aug 11, 2026
jim-smith
left a comment
Contributor
There was a problem hiding this comment.
couple of minor tweaks please.
- I'm worried that we might give the impression the safety parameters can be changed by researchers
- statbarnsdc already covers 114/5 types of analysis, and any changes to the ontology need to go through a strict approval process. So we need to make clear that we are talking about how people implement code to support functions already present in statbarnssdc
jim-smith
approved these changes
Aug 11, 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
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 updates the ACRO documentation to reflect the new ontology-driven architecture introduced. The changes explain how ACRO's disclosure checking has moved from hard-coded logic to an ontology-driven approach, making it more maintainable, auditable, and extensible.
Changes
New Files
docs/source/user_guide/architecture.rst- Detailed technical architecture reference for developers and TRE administratorsUpdated Files
API Documentation
docs/source/api.rst- Enhanced with new sections on ontology-driven checking classes (SDCChecks, SDCEvidence, ChecksResults, ManyChecksResults, TableModelDetails)docs/source/api/acro_class.rst- Expanded with complete method documentation including mitigation control methods (enable_suppression, disable_suppression, enable_rounding, disable_rounding)docs/source/api/records_class.rst- Added module-level functions and detailed class documentationLanding Pages
docs/source/index.rst- Updated release note highlighting ontology-driven architecturedocs/source/introduction.rst- explanation of principles-based SDC and three-phase pipelineUser Guide
docs/source/user_guide.rst- Improved navigation and structure with clear learning pathsdocs/source/user_guide/getting_started.rst- Beginner-friendly guide with complete workflow examplesdocs/source/user_guide/core_concepts.rst- Deep dive into SDC principles, new architecture classes, and design patternsdocs/source/user_guide/configuration.rst- configuration guide with tables, examples, and precedence rules