Skip to content

Add GitHub workflows to enforce docs style guide#3990

Merged
samsrabin merged 6 commits intoESCOMP:b4b-devfrom
samsrabin:enforce-docs-style
May 7, 2026
Merged

Add GitHub workflows to enforce docs style guide#3990
samsrabin merged 6 commits intoESCOMP:b4b-devfrom
samsrabin:enforce-docs-style

Conversation

@samsrabin
Copy link
Copy Markdown
Member

Description of changes

This PR adds a GitHub workflow to prevent the violation of these documentation style guide points:

  1. Curly apostrophes or quote marks
  2. The masculine ordinal indicator or superscript-o where a degree symbol is intended

Specific notes

Contributors other than yourself, if any: None

CTSM Issues Fixed:

Are answers expected to change (and if so in what way)? No

Any User Interface Changes (namelist or namelist defaults changes)? No

Does this create a need to change or add documentation? Did you do so? No

Testing performed, if any: Local testing with act.

@samsrabin samsrabin self-assigned this May 3, 2026
@samsrabin samsrabin added documentation additions or edits to user-facing documentation or its infrastructure b4b bit-for-bit devops Development Operations to improve development throughput, E.g., adding GitHub Workflows docs:infrastructure New features or bug fixes in the documentation infrastructure docs-loc:infrastructure Relates to documentation infrastructure next this should get some attention in the next week or two. Normally each Thursday SE meeting. labels May 3, 2026
@samsrabin samsrabin moved this to In review in CLM documentation May 3, 2026
@samsrabin samsrabin added the PR status: awaiting review Work on this PR is paused while waiting for review. label May 3, 2026
@samsrabin samsrabin linked an issue May 3, 2026 that may be closed by this pull request
@samsrabin samsrabin marked this pull request as draft May 4, 2026 15:43
@samsrabin
Copy link
Copy Markdown
Member Author

Marking as draft until I add explanations of the regex.

@ekluzek ekluzek self-requested a review May 4, 2026 16:17
@samsrabin samsrabin force-pushed the enforce-docs-style branch from 6dacd0f to 0c679e6 Compare May 4, 2026 17:57
@samsrabin samsrabin marked this pull request as ready for review May 4, 2026 17:57
@samsrabin
Copy link
Copy Markdown
Member Author

@ekluzek This is ready for review!

Copy link
Copy Markdown
Contributor

@ekluzek ekluzek left a comment

Choose a reason for hiding this comment

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

I have one comment. Mainly that I'd like to talk about this for a bit in CTSM SE partially to endorse the idea of adding comments for Reg-X expressions. And partially just to brainstorm on best ways of managing Reg-X expressions because they can be so hard to read.

Comment thread .github/workflows/docs.yml
@samsrabin samsrabin merged commit a54c80b into ESCOMP:b4b-dev May 7, 2026
7 checks passed
@github-project-automation github-project-automation Bot moved this from In review to Done in CLM documentation May 7, 2026
@slevis-lmwg slevis-lmwg mentioned this pull request May 7, 2026
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

b4b bit-for-bit devops Development Operations to improve development throughput, E.g., adding GitHub Workflows docs:infrastructure New features or bug fixes in the documentation infrastructure docs-loc:infrastructure Relates to documentation infrastructure documentation additions or edits to user-facing documentation or its infrastructure next this should get some attention in the next week or two. Normally each Thursday SE meeting. PR status: awaiting review Work on this PR is paused while waiting for review.

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

Docs: Add style guide and Workflow to check compliance

2 participants