Skip to content

Conversation

@ahouseholder
Copy link
Contributor

@ahouseholder ahouseholder commented Sep 17, 2025

  • Fix outcomes doc
  • Small refactor of overview section
  • apply black formatter to python and markdownlint to markdown
  • fix a few broken links (side effects of other changes)

Copilot summary

This pull request makes several improvements and corrections to the SSVC documentation, focusing on navigation, organization, and clarity. The most significant changes include reorganizing documentation sections for better usability, adding a new resource page, and clarifying references to outcomes and decision points. Additionally, some minor formatting and content updates were made to improve readability.

Documentation organization and navigation:

  • The "SSVC Overview" section and its links have been moved from the root to the tutorials/ directory for consistency and improved navigation. All references in docs/index.md have been updated accordingly.
  • The file docs/ssvc_overview.md was renamed to docs/tutorials/ssvc_overview.md, and internal PDF embed links were updated to reflect the new location. [1] [2]

New and improved resource content:

  • Added a new "Other Resources" page at docs/tutorials/other_resources.md, providing curated links to videos, articles, and external SSVC content.

Clarification and correction of outcomes documentation:

  • Created a new docs/reference/decision_points/outcomes.md to document outcome decision points, replacing the old docs/reference/code/outcomes.md file and updating all references accordingly. [1] [2] [3] [4]

Minor improvements and formatting:

  • Cleaned up whitespace, improved list formatting, and clarified rationale and alternatives in the versioning ADR. [1] [2] [3]
  • Updated the code documentation index to include and clarify references to new and deprecated modules.
  • Removed extraneous blank lines and improved formatting in several documentation files for consistency. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12]

These changes collectively improve the structure, clarity, and discoverability of the SSVC documentation.

@ahouseholder ahouseholder added this to the 2025-09 milestone Sep 17, 2025
@ahouseholder ahouseholder self-assigned this Sep 17, 2025
@ahouseholder ahouseholder added the content/semantic Changes to the semantic content of the SSVC documentation label Sep 17, 2025
@ahouseholder ahouseholder added content/representation Formatting, page layout, syntax, etc. tech/backend Back-end tools, code, infrastructure labels Sep 17, 2025
@ahouseholder
Copy link
Contributor Author

Merging in the interest of getting #958 across the line.

@ahouseholder ahouseholder merged commit 67c8a4a into main Sep 17, 2025
5 checks passed
@ahouseholder ahouseholder deleted the last-minute-fixes branch September 17, 2025 17:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

content/representation Formatting, page layout, syntax, etc. content/semantic Changes to the semantic content of the SSVC documentation tech/backend Back-end tools, code, infrastructure

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants