Skip to content

Move documentation documentation to documentation #3079

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
samsrabin opened this issue Apr 21, 2025 · 1 comment
Open

Move documentation documentation to documentation #3079

samsrabin opened this issue Apr 21, 2025 · 1 comment
Assignees
@samsrabin
Labels
bfb bit-for-bit documentation additions or edits to user-facing documentation test: docs Test documentation build before merging
Milestone
ctsm6.0.0 (code f...

Comments

@samsrabin
Copy link
Member

(Sorry for the too-clever title, but I couldn't resist.)

We currently have the Directions for editing CLM documentation on github and sphinx page on the wiki, but it's easy for this to fall out of date. It would be easier to keep our documentation instructions synced with the latest code if we moved those instructions to the actual User's Guide.
@samsrabin samsrabin added bfb bit-for-bit documentation additions or edits to user-facing documentation test: docs Test documentation build before merging labels Apr 21, 2025
@samsrabin samsrabin added this to the ctsm6.0.0 (code freeze) milestone Apr 21, 2025
@samsrabin samsrabin self-assigned this Apr 21, 2025
@samsrabin
Copy link
Member Author

samsrabin commented Apr 21, 2025 •
edited
Loading

Could maybe write doc-builder documentation in Markdown and embed that in the User's Guide page using mdinclude; see #2425 for an example.

@ekluzek ekluzek added the next this should get some attention in the next week or two. Normally each Thursday SE meeting. label Apr 22, 2025
@samsrabin samsrabin removed the next this should get some attention in the next week or two. Normally each Thursday SE meeting. label Apr 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@samsrabin samsrabin

Labels
bfb bit-for-bit documentation additions or edits to user-facing documentation test: docs Test documentation build before merging
Projects
CTSM6 documentation
Status: No status
Milestone
ctsm6.0.0 (code freeze)
Development

No branches or pull requests
2 participants
@samsrabin @ekluzek