Skip to content

Add proper documentation for tools/modify_input_files #3992

@samsrabin

Description

@samsrabin

What sort(s) of documentation issue is this?

  • Something is missing.
  • Something is (or might be) incorrect or outdated.
  • Something is confusing.
  • Something is broken.

What part(s) of the documentation does this concern?

  • Technical Note (science and design of the model)
  • User's Guide (using the model and related tools)
  • Somewhere else (e.g., README file, tool help text, or code comment): There are two existing README files that should be obsoleted and deleted.
  • I don't know

Describe the issue

There are two README files in tools/modify_input_files/. These should be turned into proper documentation in the User's Guide, then deleted so there's only one source of truth.

Additional context

Related:

Metadata

Metadata

Assignees

Labels

b4bbit-for-bitdocs-loc:users-guideRelates to User's Guide (using CTSM/tools)docs:newNew documentation needed (e.g., for a new feature)documentationadditions or edits to user-facing documentation or its infrastructure

Projects

Status

Todo

Status

Todo

Relationships

None yet

Development

No branches or pull requests

Issue actions