Skip to content

Inconsistent OSCAL version references and outdated onboarding documentation #2135

@Jay2006sawant

Description

@Jay2006sawant

Describe the bug

Documentation is inconsistent and outdated across key onboarding pages, which can mislead new contributors and users during setup.

Specifically:

  • README.md says trestle 3.x supports OSCAL 1.1.3
  • docs/index.md says trestle 3.x supports OSCAL 1.1.2
  • docs/tutorials/introduction_to_trestle.md references OSCAL 1.0.4 as current
  • CONTRIBUTING.md contains contributor-facing doc/tooling typos (e.g. mkbuild, documenation, aciton)

This creates confusion about which version and instructions are authoritative.

To Reproduce

Steps to reproduce the behavior:

  1. Go to README.md and check the “Development status” section (3.x -> OSCAL 1.1.3)
  2. Go to docs/index.md and check the “Important Note” section (3.x -> OSCAL 1.1.2)
  3. Go to docs/tutorials/introduction_to_trestle.md and find the “current OSCAL schema (1.0.4)” reference
  4. Go to CONTRIBUTING.md and review docs-tooling/workflow text for typos
  5. See conflicting and stale documentation guidance

Expected behavior

Documentation should be internally consistent and current across all contributor/user entry points:

  • One correct OSCAL version statement for trestle 3.x
  • Tutorial text aligned with current supported version
  • Contributor docs free of obvious tooling/workflow typos
  • New contributors can follow docs without ambiguity

Screenshots / Logs.

If applicable, add screenshots to help explain your problem.

Environment

  • OS: Ubuntu 24.04 (Linux 6.8.0-101-generic)
  • Python version: N/A (documentation issue)
  • Installed packages: N/A (documentation issue)

Are you going to solve this issue?

Yes

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    Status

    Done

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions