References: Hyphenated "Architecture-as-Code" used outside FINOS project name
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 78/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Quiet
- Domain
- documentation
Research direction
Start by reading the specified lines in docs/33_references.md, docs/06_structurizr.md, docs/31_appendix_b_technical_architecture.md, and docs/19_management_as_code.md. Compare each occurrence with the Style Guide rule, preserving proper-noun titles and URLs while changing surrounding prose to “Architecture as Code” or the italicised repository slug. Done means all affected prose follows the stated convention.
Written by the indexing model from the issue text.
Description
Category: style / references
Severity: low
Problem
The hyphenated form "Architecture-as-Code" is reserved for the FINOS project slug only. Using it in prose contradicts the Style Guide's "always write Architecture as Code" rule.
Affected files
docs/33_references.md:33("GDPR for Organisations" cites a URL containing/for-organizations/— URL fine, but "organisations" vs "organizations" inside title could be clarified)docs/33_references.md:42docs/06_structurizr.md:1278docs/31_appendix_b_technical_architecture.md:67, 323docs/19_management_as_code.md:59
Suggested fix
Retain "Architecture-as-Code" inside proper-noun project titles and URLs. In surrounding prose, refer to "the FINOS Architecture as Code project" or "the architecture-as-code repository" (italicised, as a code-slug reference).
Auto-generated by editorial review agent.
- Dominant language
- Python
- Stars
- 4
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from Geonitab/architecture_as_code
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
Geonitab/architecture_as_code#1930 ·
-
design documentation
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
Geonitab/architecture_as_code#1885 ·
-
design documentation
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Geonitab/architecture_as_code#1874 ·
-
design documentation
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
Geonitab/architecture_as_code#1869 ·
-
documentation language
Difficulty 1/5 Under an hour Newbie friendliness 86/100
Geonitab/architecture_as_code#1850 ·
All issues in Geonitab/architecture_as_code
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100