Repository navigation
Refactor analysis documentation and improve clarity - #13
Merged
Merged
Conversation
- Updated the question in the analysis JSON for better specificity regarding OSCAL models and automated checks. - Revised meta descriptions and content in index.html files for analyses, patterns, and recommendations to enhance clarity and consistency. - Improved the wording in the lede paragraphs across various HTML files to better convey the purpose of each section. - Added a new JavaScript file for regression checks related to analysis-scoped progress notices, ensuring proper functionality and coverage. - Enhanced error messages and handling in the site.js file for better user experience during loading failures.
- Updated six-questions.json to clarify rule requirements. - Modified bannercheck.js to use CSS variables for styling. - Added source_path function in extract.py for better file resolution. - Enhanced pagecheck.js to ensure snippet accessibility. - Improved verify.py with better command descriptions and offline handling. - Introduced schema_evidence.py for refreshing schema fragments from NIST. - Created schema_validation.py to validate NIST schemas with Unicode support. - Added test_verify.py for regression testing of the verifier without external dependencies.
- Removed markdown snippets from the manifest, ensuring all entries are OSCAL JSON. - Updated `package.py` to clarify the handling of excluded files and maintain alignment with the package structure. - Enhanced `pagecheck.js` to improve clarity in comments and checks for quotation and attribution hooks. - Revised `scenario_page.py` to simplify comments regarding option-letter order. - Modified `test_verify.py` to enforce that only OSCAL JSON snippets are included and to ensure editorial checks do not allow background attribution. - Updated `verify.py` to clarify checks for editorial references and ensure no background document attribution is present in editorial data.
- Replaced direct extraction calls with a new source_inputs module to manage source paths and integrity checks. - Implemented a source lock JSON file to define and validate source configurations. - Enhanced error handling in OSCAL artifact processing to provide clearer feedback on source issues. - Added comprehensive unit tests for source input management, ensuring robustness against various edge cases. - Updated existing tests to align with the new source input structure and validation logic.
…ving output checks
…technical hardening guidance. Necessary to fix broken tests with dependencies that would not resolve from internet connections.
3 tasks
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 pull request updates the
README.mdand the analysis HTML page to clarify documentation, improve consistency, and add details about the "Work in progress" banner behavior for analyses. The changes focus on making descriptions more concise, updating terminology, and documenting new UI behavior for analysis status.Documentation improvements and clarifications:
README.mdfor clarity, including the project overview, purpose, and repository structure. This includes clarifying the role of the OSCAL Foundation, simplifying section explanations, and updating terminology (e.g., "Contents" instead of "What it holds").Analysis UI and metadata updates:
<aside class="wip-banner">) to the analysis HTML page (assessment-first.html) that is shown based on analysis status.These changes improve the clarity, usability, and maintainability of the documentation and analysis presentation.- Updated the question in the analysis JSON for better specificity regarding OSCAL models and automated checks.