Skip to content

Commit 606cce4

Browse files
feat(docs): add compliance badge, update language list and references
Add custom DevRail compliance badge SVG and badge documentation page. Update supported languages list from 4 to 7 (add ruby, go, javascript). Add badge and agents links to getting-started index. Update contributing cross-references from contributing-a-language.md to contributing.md. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent fa9e007 commit 606cce4

File tree

6 files changed

+63
-3
lines changed

6 files changed

+63
-3
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ This site uses Hugo with the [Docsy](https://www.docsy.dev/) theme via Go module
3737

3838
See [DEVELOPMENT.md](DEVELOPMENT.md) for development standards and contribution guidelines.
3939

40-
To add a new language ecosystem to DevRail, see the [Contributing a New Language Ecosystem](../standards/contributing-a-language.md) guide.
40+
To add a new language ecosystem to DevRail, see the [Contributing to DevRail](../standards/contributing.md) guide.
4141

4242
## License
4343

content/docs/contributing/adding-a-language.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ description: "Step-by-step guide for adding a new language ecosystem to DevRail.
88
Adding a new language to DevRail involves changes across multiple repositories. This guide walks through the complete process.
99

1010
{{% alert title="Canonical Reference" color="info" %}}
11-
The authoritative, detailed version of this guide with full code templates and concrete examples lives in the `devrail-standards` repo at [`standards/contributing-a-language.md`](https://github.com/devrail-dev/devrail-standards/blob/main/standards/contributing-a-language.md). This page provides the overview; the canonical guide provides copy-pasteable templates for every step.
11+
The authoritative, detailed version of this guide with full code templates and concrete examples lives in the `devrail-standards` repo at [`standards/contributing.md`](https://github.com/devrail-dev/devrail-standards/blob/main/standards/contributing.md). This page provides the overview; the canonical guide provides copy-pasteable templates for every step.
1212
{{% /alert %}}
1313

1414
## Overview

content/docs/getting-started/_index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ All other tools (linters, formatters, security scanners, test runners) are pre-i
2424
- **[New Project](/docs/getting-started/new-project/)** -- Start a new repository from a DevRail template. All configuration files are pre-set.
2525
- **[Retrofit Existing Project](/docs/getting-started/retrofit/)** -- Add DevRail standards to a repository you already have.
2626
- **[Working with AI Agents](/docs/getting-started/agents/)** -- Get AI coding agents to follow DevRail standards in your projects.
27+
- **[Compliance Badge](/docs/getting-started/badge/)** -- Add a DevRail compliance badge to your README.
2728

2829
## Verify Your Setup
2930

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
title: "Compliance Badge"
3+
linkTitle: "Badge"
4+
weight: 40
5+
description: "Add a DevRail compliance badge to your project README."
6+
---
7+
8+
Show that your project follows DevRail standards by adding a compliance badge to your README.
9+
10+
## Custom Badge (Hosted)
11+
12+
```markdown
13+
[![DevRail compliant](https://devrail.dev/images/badge.svg)](https://devrail.dev)
14+
```
15+
16+
**Preview:**
17+
18+
[![DevRail compliant](/images/badge.svg)](https://devrail.dev)
19+
20+
## Shields.io Badge (Alternative)
21+
22+
If you prefer shields.io hosted badges:
23+
24+
```markdown
25+
[![DevRail](https://img.shields.io/badge/DevRail-compliant-0969da)](https://devrail.dev)
26+
```
27+
28+
## Where to Place It
29+
30+
Add the badge near the top of your `README.md`, alongside other project badges (CI status, license, version):
31+
32+
```markdown
33+
# My Project
34+
35+
[![CI](https://github.com/OWNER/REPO/actions/workflows/lint.yml/badge.svg)](...)
36+
[![DevRail compliant](https://devrail.dev/images/badge.svg)](https://devrail.dev)
37+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
38+
```

content/docs/getting-started/new-project.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ fail_fast: false
3535
log_format: json
3636
```
3737
38-
Supported languages: `python`, `bash`, `terraform`, `ansible`. List only the languages your project actually uses.
38+
Supported languages: `python`, `bash`, `terraform`, `ansible`, `ruby`, `go`, `javascript`. List only the languages your project actually uses.
3939

4040
### Step 3: Install Pre-Commit Hooks
4141

static/images/badge.svg

Lines changed: 21 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)