-
Notifications
You must be signed in to change notification settings - Fork 42
Refactor default decision point values from collect.md to includable files #1013
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Refactor default decision point values from collect.md to includable files #1013
Conversation
Co-authored-by: ahouseholder <2594236+ahouseholder@users.noreply.github.com>
Co-authored-by: ahouseholder <2594236+ahouseholder@users.noreply.github.com>
Co-authored-by: ahouseholder <2594236+ahouseholder@users.noreply.github.com>
Co-authored-by: ahouseholder <2594236+ahouseholder@users.noreply.github.com>
Co-authored-by: ahouseholder <2594236+ahouseholder@users.noreply.github.com>
Co-authored-by: ahouseholder <2594236+ahouseholder@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR refactors the "Default Exploitation Values" tip from a single location into a reusable include file to improve content maintainability and consistency across the documentation.
- Created a new include file
docs/_includes/default_exploitation_values.mdcontaining the tip content - Replaced the original tip in
collect.mdwith an include statement - Added the include to two additional documentation pages for broader coverage
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/_includes/default_exploitation_values.md | New include file containing the default exploitation values tip with relative paths |
| docs/howto/bootstrap/collect.md | Replaced inline tip content with include statement |
| docs/reference/decision_points/exploitation.md | Added include for the default exploitation values tip |
| docs/howto/gathering_info/exploitation.md | Added include for the default exploitation values tip |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: ahouseholder <2594236+ahouseholder@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
Copilot reviewed 12 out of 12 changed files in this pull request and generated 4 comments.
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Removed an include statement for default safety values and clarified the expansive view of safety in relation to well-being.
…ation-values' into copilot/refactor-default-exploitation-values
This pull request refactors how default values for several decision points are documented by moving their content into dedicated include files and updating various documentation pages to use these includes. This improves maintainability and consistency across the documentation. Additionally, it updates the markdown include plugin configuration to better handle relative links.
Documentation refactoring:
Exploitation,System Exposure,Safety Impact, andMission Impactin thedocs/_includesdirectory, consolidating their content for reuse. [1] [2] [3] [4]collect.md,gathering_info/exploitation.md,gathering_info/mission_impact.md,gathering_info/system_exposure.md,decision_points/exploitation.md,decision_points/mission_impact.md,decision_points/safety_impact.md,decision_points/system_exposure.md) to use the new markdown includes for default decision point values, replacing inline content. [1] [2] [3] [4] [5] [6] [7] [8]Plugin configuration improvements:
include-markdownplugin configuration inmkdocs.ymlto enablerewrite_relative_links, ensuring that relative links in included markdown files resolve correctly.Minor cleanup:
mkdocs.ymlfor tidiness.