Skip to content

docs: remove model-specific references from documentation#4976

Draft
Copilot wants to merge 3 commits intomasterfrom
copilot/remove-model-references-docs
Draft

docs: remove model-specific references from documentation#4976
Copilot wants to merge 3 commits intomasterfrom
copilot/remove-model-references-docs

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 29, 2026

Description

Remove model-specific documentation (CESM namelist URLs, CESM-ECT branding, cheyenne machine references, CESM-specific paths) while preserving model references that provide useful context for users.

Removed (not directly relevant to CIME):

  • CESM-specific active component namelist section in setting-up-a-case.rst (CAM, CLM, CICE, POP2, CISM with cesm.ucar.edu URLs) — replaced with generic component namelist guidance
  • CESM-ECT branding/paths/URLs in tools/ect.rst and support-a-new-machine.rst
  • Cheyenne-specific test commands and paths throughout
  • CESM-specific path examples (/glade/scratch/cesm_user, $CESMDATAROOT)

Generalized (relevant to CIME, made model-agnostic):

  • Docker examples in contributing-guide.rst<model> placeholders
  • Test output paths in system_testing.rst
  • Grid config paths in grids.rst
  • "CESM executable" → "model executable" in running-a-case.rst
  • "CAM and CLM history files" → "component history files" in troubleshooting.rst
  • Added context notes to model-specific example outputs (timers, preview_run)

Kept (provides useful context):

  • E3SM/CESM project links in footer, prerequisites, CIME_MODEL possibilities
  • Compset examples with model attribution, historical convention notes
  • XML config examples showing real values (cime_model="cesm")

Also fixes pre-existing typo: tempororaltemporal in pes.rst.

Checklist

  • My code follows the style guidelines of this project (black formatting)
  • I have performed a self-review of my own code
  • My changes generate no new warnings
  • I have added tests that exercise my feature/fix and existing tests continue to pass
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding additions and changes to the documentation

Copilot AI linked an issue Apr 29, 2026 that may be closed by this pull request
Copilot AI and others added 2 commits April 29, 2026 18:09
- Replace CESM-specific active component namelist section with generic guidance
- Generalize CESM-ECT documentation to generic ECT documentation
- Remove CESM-specific URLs to namelist documentation and verification website
- Remove model-specific machine references (cheyenne) from examples
- Generalize CESM-specific paths in examples to use placeholders
- Add notes to model-specific example outputs for context
- Keep model references where they provide useful context (e.g. listing
  CIME-driven models, historical conventions, concrete examples)

Agent-Logs-Url: https://github.com/ESMCI/cime/sessions/2ef12468-32a6-42e3-a377-f05a2a354d5c

Co-authored-by: jasonb5 <2191036+jasonb5@users.noreply.github.com>
Copilot AI changed the title [WIP] Remove model references from documentation docs: remove model-specific references from documentation Apr 29, 2026
Copilot AI requested a review from jasonb5 April 29, 2026 18:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Remove model references from documentation

2 participants