Skip to content
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.

Sign up for GitHub

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

Jump to bottom

docs: add guide for enriching security vulnerabilities with AI #1905

Open
wants to merge 14 commits into
base: main
Choose a base branch
from
Open

docs: add guide for enriching security vulnerabilities with AI #1905

wants to merge 14 commits into from

Conversation

devin-ai-integration[bot]
Copy link
Contributor

@devin-ai-integration devin-ai-integration bot commented Jan 1, 2025 •
edited
Loading

This PR adds a new guide for enriching security vulnerabilities using AI.

Changes:

  • Added guide following template structure from docs/generalTemplates/_guide_template_for_ai.md
  • Added example image showing AI summary feature
  • Preserved all original code examples and configurations
  • Added guide to navigation system
  • Improved formatting per review feedback:
    • Added informative titles to admonitions
    • Added periods to all list items
    • Indented code blocks and details/summary components in lists
    • Added border to example image

Preview: https://pr-1905.d2ngvl90zqbob8.amplifyapp.com/guides/all/enrich-security-vulnerabilities-with-ai

Link to Devin run: https://app.devin.ai/sessions/36f955d0e3f441b59cfa5f1239f7c392

Testing:

  • Verified preview deployment displays correctly
  • Confirmed all sections render properly
  • Validated code blocks and image display
  • Checked navigation integration
  • Verified all formatting improvements through preview deployment
  • Confirmed CI checks passing

@hadar-co I've addressed all the formatting feedback. Please review the changes when you have a chance.

@devin-ai-integration Devin.ai Integration
Copy link
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add "(aside)" to your comment to have me ignore it.
  • Look at CI failures and help fix them

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

@aws-amplify-eu-west-1 AWS Amplify (eu-west-1)
Copy link

This pull request is automatically being deployed by Amplify Hosting (learn more).

Access this pull request here: https://pr-1905.d2ngvl90zqbob8.amplifyapp.com

@Matanga1-2 Matanga1-2 requested a review from hadar-co January 1, 2025 20:04
@Matanga1-2
Copy link
Contributor

(aside) @hadar-co can we add a new logo to the AI technology?

devin-ai-integration bot and others added 2 commits January 7, 2025 19:43
@devin-ai-integration
docs: enhance AI integration customization instructions
659006b 
Co-Authored-By: [email protected] <[email protected]>
@devin-ai-integration
docs: restructure guide to match template format
657c9ed 
- Remove 'goal of this guide' section
- Add 'Set up data model' section with proper subsections
- Rename 'Define Action Configuration' to 'Create self-service actions'
- Improve section organization and transitions
- Preserve all code snippets unchanged

Co-Authored-By: [email protected] <[email protected]>
@hadar-co
Copy link
Contributor

hadar-co commented Jan 8, 2025

Address the following comments and change the PR accordingly:

  1. When creating admonitions, always give them a short informative title, the syntax looks like this:
    :::admonitionType TITLE GOES HERE
    content
    :::

  2. In numbered/bullet lists, each item should end with a period.

  3. In numbered/bullet lists, when an item includes a code snippet or summary&details component, it should be indented so it renders under that item.

  4. All images in a guide should have a simple border, for example: <img src="..." border="1px" />

devin-ai-integration bot and others added 7 commits January 8, 2025 12:37
@devin-ai-integration
docs: improve guide formatting and readability
9834e0d 
- Add periods to list items for consistency
- Indent code blocks and details/summary components
- Add border to example image
- Improve admonition titles

Co-Authored-By: [email protected] <[email protected]>
@devin-ai-integration
docs: fix MDX compilation error in AI security guide
99d0999 
Co-Authored-By: [email protected] <[email protected]>
@devin-ai-integration
docs: fix image border syntax in AI security guide
a105e64 
Co-Authored-By: [email protected] <[email protected]>
@devin-ai-integration
docs: update image syntax from Markdown to HTML
6236b72 
Co-Authored-By: [email protected] <[email protected]>
@devin-ai-integration
docs: fix code snippet formatting for action item in AI security guide
30824e8 
Co-Authored-By: [email protected] <[email protected]>
@devin-ai-integration
docs: fix formatting for AI security guide
7e420f4 
- Add periods to all numbered list items
- Ensure consistent code block indentation
- Update image tag formatting

Co-Authored-By: [email protected] <[email protected]>
@devin-ai-integration
docs: fix code snippet indentation hierarchy in AI security guide
0b897b6 
Co-Authored-By: [email protected] <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Matanga1-2 Matanga1-2 Matanga1-2 left review comments

@hadar-co hadar-co Awaiting requested review from hadar-co

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@Matanga1-2 @hadar-co