fix: align OSCAL version references and fix CONTRIBUTING.md typos#2141
Open
Acuspeedster wants to merge 2 commits intooscal-compass:developfrom
Open
fix: align OSCAL version references and fix CONTRIBUTING.md typos#2141Acuspeedster wants to merge 2 commits intooscal-compass:developfrom
Acuspeedster wants to merge 2 commits intooscal-compass:developfrom
Conversation
…cal-compass#2135) - docs/index.md: update all trestle 3.x OSCAL references from 1.1.2 to 1.1.3 to match README.md and the actual OSCAL upgrade in the codebase (see CHANGELOG: 'feat: upgrade to OSCAL 1.1.3 (oscal-compass#1795)') - docs/tutorials/introduction_to_trestle.md: update stale OSCAL 1.0.4 reference to current 1.1.3 - CONTRIBUTING.md: fix three typos: - 'aciton' -> 'action' in PR workflow section - 'mkbuild' -> 'mkdocs build' (correct tool name) - 'documenation' -> 'documentation' Closes oscal-compass#2135 Signed-off-by: Acuspeedster <arnavrajsingh@gmail.com>
- 'Commit's' -> 'Commits' (spurious possessive apostrophe) - 'overrided' -> 'overridden' (incorrect past participle) - 'title's' -> 'titles' and 'an [convention commit]' -> 'a [conventional commit]' - 'Code style and formating' -> 'Code style and formatting' Signed-off-by: Acuspeedster <arnavrajsingh@gmail.com>
Acuspeedster
changed the title
Contributor
Author
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
1 participant
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.
Description
fix: align OSCAL version references and fix documentation typos (#2135)
closes #2135
docs/index.md: update all trestle 3.x OSCAL references from 1.1.2 to 1.1.3 to match README.md and the actual OSCAL upgrade in the codebase (see CHANGELOG: 'feat: upgrade to OSCAL 1.1.3 (feat: upgrade to OSCAL 1.1.3 #1795)')docs/tutorials/introduction_to_trestle.md: update stale OSCAL 1.0.4 reference to current 1.1.3CONTRIBUTING.md: fix typos throughout:aciton->actionin PR workflow sectionmkbuild->mkdocs build(correct tool name)documenation->documentationCommit's->Commits(spurious possessive apostrophe)overrided->overridden(incorrect past participle)title's->titlesandan [convention commit]->a [conventional commit]Code style and formating->Code style and formattingCloses #2135
Types of changes
develop->main)Quality assurance (all should be covered).
Summary
This PR resolves the documentation inconsistency reported in #2135. The
docs/index.mdanddocs/tutorials/introduction_to_trestle.mdfiles contained stale OSCAL version references (1.1.2 and 1.0.4 respectively) that did not match the authoritative value inREADME.md(1.1.3) or the actual upgrade performed in the codebase (CHANGELOG:feat: upgrade to OSCAL 1.1.3 (#1795)).CONTRIBUTING.mdalso contained several contributor-facing typos that could cause confusion for new contributors following the workflow documentation. All typos have been corrected.No code changes documentation only.
Key links:
Before you merge