Tags

Documentation improvements, ongoing implementation of dotstop (TSF-specific replacement for Doorstop) and documentation on the RAFIA process.

### Change Summary

- Added API references for trustable_compliance, graphalyzer and dotstop
- Added Lint and format checks using ruff
- Progess on implementation of dotstop
    - Read and write dotstop graphs and items natively from files
    - Reference management and reference plug-in support, including unit tests
    - YAML front matter schema
- Improved guidance for TA-MISBEHAVIOURS and associated glossary definitions
- RAFIA process documentation, illustrating some specific applications of TSF
- Renamed and expanded the TAs

Improved user instructions

### Changes

- Improved tool and getting started documentation
- Guidance on organisation of items and graphs
- Clarifications and improved guidance for TA items
- Criteria for SME assessments
- Clarified documentation about review and the review status field
- Small TSF tool improvements, including graduated colour maps for scores

## Known issues

* See list for previous release (unchanged)

Release of project in preparation for public launch.

### Changes

- Added licenses for documentation and tools
- Removed deprecated validator code
- Improved release job to publish package in project PyPi via twine
- Improved readability for text on coloured background in compliance report

## Known issues

* Mermaid diagram rendering is broken in the Compliance documentation
* Needs guidance on how to:
    - Import existing requirements into a TSF graph
    - Integrate TSF graphs from other projects
* Missing API reference pages for `trustable-compliance`
- Support for multi-repository usage of TSF is *experimental only* and
  has a number of known issues (see compliance/remote.md#pitfalls)

Interim release of project in its new context on gitlab.com

### Changes

* CI and tooling updated to build for the new context
* Theme and document generation configuration updated to a Trustable theme

### Resolved issues

* Guidance for TA-18 and TA-20 needs adding

### Known issues

* Mermaid diagram rendering is broken in the Compliance documentation
* Needs guidance on how to:
    - Import existing requirements into a TSF graph
    - Integrate TSF graphs from other projects
* Missing API reference pages for `trustable-compliance`
- Support for multi-repository usage of TSF is *experimental only* and
  has a number of known issues( see compliance/remote.md#pitfalls)

RC2 to verify that releasing issue is resolved

Release candidate to verify release procedure in the project's new context

Further refinement of the methodology, tooling to support confidence scoring
and a refactoring of the Trustable Assertions to align with the TSF graph model.

### Changes

* Tooling extended and improved to support:
    - New 'dotstop' interface layer to support new graph model design in future
    - Restructured Trustable report
* Documentation extended and improved to:
    - Design concept description for 'dotstop'
    - Refined requirements management process
    - Expanded and improved methodology
* Trustable Assertions and Tenets updated to:
    - Separate informative (guidance) from normative (Statements) text
    - Change TA UIDs to define a new 'series', with a series identifier (A)
      and a new numerical sequence for the Items

### Known issues

* Needs guidance on how to:
    - Import existing requirements into a TSF graph
    - Integrate TSF graphs from other projects
* Missing API reference pages for `trustable-compliance`
* Guidance for TA-18 and TA-20 needs adding
- Support for multi-repository usage of TSF is *experimental only* and
  has a number of [known issues](compliance/remote.md#pitfalls)

Release candidate for v2025.01.24

TSF Release v2024.12.19

Further refinement of the methodology, tooling to support confidence scoring and a refactoring of the Trustable Assertions to align with the TSF graph model.

## Changes

- Tooling extended and improved to support:
    -  Autogenerate the Trustable Tenets and Assertions diagram from Doorstop Items
    - Add support for aggregating confidence scores from Doorstop Items
    - Inclusion of inlined Artifacts in the Trustable Report 
- Documentation extended and improved to:
    - Clarify and refine the methodology, adding diagrams to illustrate the TSF graph model
    - Provide detailed instructions for creating, storing, and managing a TSF graph
    - Refactor the Trustable Assertions to address identified problems and align their relationships with the TSF graph logic

## Resolved issues

- Guidance added to documentation for how to:
    - Integrate the Trustable TSF graph into a project
    - Update a TSF graph when evidence changes

## Known issues

- Needs guidance on how to:
    - Import existing requirements into a TSF graph 
    - Integrate TSF graphs from other projects
- Missing API reference pages for trustable-compliance
- Guidance for TA-18 and TA-20 needs adding
- Support for multi-repository usage of TSF is experimental only and has a number of known issues

# v2024.11.29 Release

Updates to support confidence scoring, reporting and provide guidance to users on the use of the TSF tools and methodology.

## Changes

- Tooling extended and improved to support:
    - Recording and management of confidence scores
    - Plotting graphical summaries of databases
    - Improved compliance reporting
- Documentation extended and improved to:
    - Describe what TSF compliance involves
    - Explain how to start applying TSF to a project
    - Add instructions for installing and updating TSF tools
    - Add guidance for projects applying TSF on the use of a -trustable suffix on release versions

## Resolved issues

    Tooling to support confidence scoring is now provided
    Spurious 'fatal error' reported by trustable-compliance fixed

## Known issues

- Needs guidance on how to:
    - Integrate the Trustable TSF graph into a project
    - Import existing requirements into a TSF graph
    - Update a TSF graph when evidence changes
    - Integrate TSF graphs from other projects
- Missing API reference pages for trustable-compliance

Second release candidate for November release

Release candidate for v2024.11.29 and MR !79

Test again

Initial release of Trustable Software Framework

### Changes

* Overview and rationale for Trustable
* Preliminary guidance on implementation
* Methodology for authoring and organising TSF metadata
* Instructions for managing metadata using Doorstop
* Examples of automated verification
* Report generation tooling based on custom version of Doorstop

### Known issues

* Integration of the TSF Doorstop tree into a project is a manual process
* Tooling to support confidence scoring is not yet provided
* Needs clearer guidance on:
    - How to import existing requirements into a TSF Doorstop tree
    - How to update Doorstop when evidence changes

Marking imported sources for v2024.07.24 release of SIF Documentation Portal