Skip to content

Commit d661823

Browse files
[docs] docs: remove bloat from capitalization guidelines (#3763)
1 parent fe8fc89 commit d661823

1 file changed

Lines changed: 2 additions & 32 deletions

File tree

docs/src/content/docs/reference/capitalization.md renamed to specs/capitalization.md

Lines changed: 2 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -19,29 +19,7 @@ The CLI uses different capitalization based on context:
1919

2020
## Design Rationale
2121

22-
This approach balances several considerations:
23-
24-
### Clarity
25-
26-
Using different capitalization distinguishes between referring to the product (GitHub Agentic Workflows) and the concept (agentic workflows). Users can immediately understand whether documentation discusses the tool itself or the workflows it manages.
27-
28-
### Industry Standards
29-
30-
The pattern follows established conventions where product names use title case while generic references use sentence case. This matches how other CLI tools handle similar distinctions (e.g., "GitHub Actions" as a product vs. "actions" as workflow components).
31-
32-
### Consistency
33-
34-
Applying the same rules across all commands creates a predictable user experience. The pattern extends to:
35-
36-
- Command short descriptions
37-
- Command long descriptions
38-
- Help text
39-
- Error messages
40-
- Documentation
41-
42-
### Maintenance
43-
44-
The approach simplifies decision-making for contributors. The rule is simple: capitalize when referring to the product by name, use lowercase for generic workflow references.
22+
This capitalization convention distinguishes between the product name (GitHub Agentic Workflows) and the concept (agentic workflows), following industry standards similar to "GitHub Actions" vs. "actions". The consistent pattern across all commands, help text, and documentation simplifies both user comprehension and contributor decision-making.
4523

4624
## Examples
4725

@@ -60,14 +38,9 @@ When describing actions performed on workflows:
6038

6139
```
6240
Enable agentic workflows
63-
Disable agentic workflows and cancel any in-progress runs
64-
Show status of agentic workflows
6541
Initialize repository for agentic workflows
66-
Download and analyze agentic workflow logs with aggregated metrics
42+
Download and analyze agentic workflow logs
6743
Add an MCP tool to an agentic workflow
68-
List MCP servers defined in agentic workflows
69-
Run one or more agentic workflows on GitHub Actions
70-
Trial one or more agentic workflows as if they were running in a repository
7144
```
7245

7346
### Technical Terms (Capitalized)
@@ -89,6 +62,3 @@ The capitalization rules are enforced through automated tests in `cmd/gh-aw/capi
8962

9063
The tests run as part of the standard test suite and prevent inconsistencies from being introduced.
9164

92-
## Historical Context
93-
94-
This pattern was established to resolve potential confusion between the product and the concept. Early analysis confirmed the codebase already followed this approach consistently, and the formalization through tests and documentation prevents future drift.

0 commit comments

Comments
 (0)