Skip to content

Docs docs: VS Code setup#3981

Merged
samsrabin merged 5 commits intoESCOMP:b4b-devfrom
samsrabin:docs-docs-vscode-setup
May 7, 2026
Merged

Docs docs: VS Code setup#3981
samsrabin merged 5 commits intoESCOMP:b4b-devfrom
samsrabin:docs-docs-vscode-setup

Conversation

@samsrabin
Copy link
Copy Markdown
Member

Description of changes

Describes my setup for editing documentation in VS Code, including syntax highlighting, autocomplete, and previewing.

Specific notes

Contributors other than yourself, if any: None so far... But looking for guinea pigs!

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? n/a

Testing performed, if any: Doc build tests and previewing.

@samsrabin samsrabin self-assigned this Apr 30, 2026
@samsrabin samsrabin added documentation additions or edits to user-facing documentation or its infrastructure b4b bit-for-bit labels Apr 30, 2026
@samsrabin samsrabin added docs:new New documentation needed (e.g., for a new feature) docs-loc:users-guide Relates to User's Guide (using CTSM/tools) labels Apr 30, 2026
@samsrabin samsrabin changed the base branch from master to b4b-dev April 30, 2026 15:04
@samsrabin samsrabin moved this to In Progress in CLM documentation Apr 30, 2026
@samsrabin samsrabin added 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. labels Apr 30, 2026
@samsrabin samsrabin removed the next this should get some attention in the next week or two. Normally each Thursday SE meeting. label Apr 30, 2026
@samsrabin samsrabin moved this from In Progress to In review in CLM documentation Apr 30, 2026
Comment thread doc/source/users_guide/working-with-documentation/vscode-doc-editing-setup.md Outdated
@samsrabin samsrabin added this to the ctsm6.0.0 (code freeze) milestone May 4, 2026
@adrifoster
Copy link
Copy Markdown
Contributor

Thanks and worked great!

You might also want to add how to turn on text wrapping?

Copy link
Copy Markdown
Contributor

@adrifoster adrifoster left a comment

Choose a reason for hiding this comment

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

Super useful! Thanks for doing this

@samsrabin samsrabin merged commit 8feb228 into ESCOMP:b4b-dev May 7, 2026
6 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 docs:new New documentation needed (e.g., for a new feature) docs-loc:users-guide Relates to User's Guide (using CTSM/tools) documentation additions or edits to user-facing documentation or its infrastructure 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.

User's Guide: Add instructions for VS Code docs-editing setup

2 participants