Skip to content

add documentation policy pipeline #76

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

Merged
timbastin merged 5 commits into from
Feb 3, 2026
Merged

add documentation policy pipeline #76

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e394bdd
debug message
5byuri Jan 26, 2026
8e089b9
added new badge variant and documentation required explaination
5byuri Feb 3, 2026
c853c2d
remove debug message
5byuri Feb 3, 2026
4071882
devguard-docs -> devguard-documentation
5byuri Feb 3, 2026
3270b5b
Merge branch 'main' into getting-started-update
5byuri Feb 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@
Manage your CVEs seamlessly, Integrate your Vulnerability Scanners, Documentation made easy, Compliance to security Frameworks
<br />
<br />
<a href="https://github.com/l3montree-dev/devguard-docs/issues">Report Bug</a>
<a href="https://github.com/l3montree-dev/devguard-documentation/issues">Report Bug</a>
·
<a href="https://github.com/l3montree-dev/devguard-docs/issues">Request Feature</a>
<a href="https://github.com/l3montree-dev/devguard-documentation/issues">Request Feature</a>
</p>
</div>

Expand Down
2 changes: 1 addition & 1 deletion SECURITY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Older tags need manual updating, as we do not usually release an updated image f

## Reporting a Vulnerability

When reporting a vulnerability, you can use GitHub's "Private Vulnerability Reporting". Just navigate to the [Report a vulnerability](https://github.com/l3montree-dev/devguard-docs/security/advisories/new) page. This way, maintainers will privately notified first. Afterwards, in a best-case scenario, if the vulnerability is fixed, the report will be made public.
When reporting a vulnerability, you can use GitHub's "Private Vulnerability Reporting". Just navigate to the [Report a vulnerability](https://github.com/l3montree-dev/devguard-documentation/security/advisories/new) page. This way, maintainers will privately notified first. Afterwards, in a best-case scenario, if the vulnerability is fixed, the report will be made public.

Alternatively, you can report a vulnerability or anomaly to the L3montree development team. This initiates the procedure of a Coordinated Vulnerability Disclosure. The team will then endeavour to develop security patches within a week if possible. The vulnerability is then made public in the course of their publication. If you wish, you can also be published as a reporter.

Expand Down
2 changes: 1 addition & 1 deletion public/example-sbom-devguard-docu.json
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 2 additions & 0 deletions src/components/ui/badge.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ const badgeVariants = cva(
'bg-[#26264a] text-[#c2b8ff] ring-1 ring-[#565280] text-sm h-5',
devguardWebBadge:
'bg-[#162c41] text-[#3aadff] ring-1 ring-[#1d4d73] text-sm h-5',
documentationRequired:
'bg-[#cfbe50]/[0.18] text-[#cfbe4f] ring-1 ring-[#cfbe4f]/[0.3] text-sm h-5',
upcoming:
'bg-blue-400/10 text-blue-400 ring-1 ring-blue-400 text-sm h-6',
},
Expand Down
2 changes: 2 additions & 0 deletions src/pages/contributing/getting-started.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,3 +139,5 @@ npm run dev

If you need assistance or want to connect with the team, feel free to join our [Matrix Community Server](https://matrix.to/#/#devguard:matrix.org) and reach out directly. The Devguard team is happy to support new contributors.

Some tickets are labeled with a <a href='https://github.com/l3montree-dev/devguard/issues?q=is%3Aissue%20state%3Aopen%20label%3ADOCUMENTATION-REQUIRED'><Badge variant="documentationRequired"> DOCUMENTATION-REQUIRED</Badge></a> badge. When you see this label, the code changes in your contribution also require corresponding documentation updates in the <a href='https://github.com/l3montree-dev/devguard-documentation'>Devguard Documentation Repository</a>.
Copy link

Copilot AI Feb 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This new contributor note links to https://github.com/l3montree-dev/devguard-documentation, but the rest of this repo references l3montree-dev/devguard-docs (e.g., README.md and SECURITY.md). If the documentation repository is actually devguard-docs, update this link (and the visible name capitalization) so contributors are sent to the right place.

Copilot uses AI. Check for mistakes.
Copy link

Copilot AI Feb 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

JSX attributes in this file use double quotes (and Prettier’s default for JSX is double quotes). These new <a href='...'> attributes use single quotes—please switch them to double quotes for consistency/formatting stability.

Copilot uses AI. Check for mistakes.
Please ensure your documentation pull request uses the same title as the original issue for easy tracking.