-
Notifications
You must be signed in to change notification settings - Fork 101
Closed
Closed
Copy link
Description
Describe the bug
Documentation is inconsistent and outdated across key onboarding pages, which can mislead new contributors and users during setup.
Specifically:
README.mdsaystrestle 3.xsupports OSCAL1.1.3docs/index.mdsaystrestle 3.xsupports OSCAL1.1.2docs/tutorials/introduction_to_trestle.mdreferences OSCAL1.0.4as currentCONTRIBUTING.mdcontains 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:
- Go to
README.mdand check the “Development status” section (3.x -> OSCAL 1.1.3) - Go to
docs/index.mdand check the “Important Note” section (3.x -> OSCAL 1.1.2) - Go to
docs/tutorials/introduction_to_trestle.mdand find the “current OSCAL schema (1.0.4)” reference - Go to
CONTRIBUTING.mdand review docs-tooling/workflow text for typos - 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
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels
Type
Projects
Status
Done