Skip to content

docs: add a tip on using an AI assistant to get oriented with DES3D - #98

Merged
echoi merged 3 commits into
mainfrom
docs-intro-ai-assistant-tip
Oct 30, 2026
Merged

echoi merged 3 commits into
mainfrom
docs-intro-ai-assistant-tip

Conversation

@echoi

@echoi echoi commented Oct 30, 2026 •

Copy link
Copy Markdown
Contributor

Summary

  • Adds a :::tip admonition at the end of docs/intro.md on using an AI coding assistant to get oriented with DES3D: point it at this documentation site and any background papers, describe the tectonic scenario in plain language, and iterate on the resulting .cfg together, while treating its output as a draft to check rather than a substitute for understanding the parameters. Distilled from a user's account of learning DES3D this way, generalized and with all project-specific/personal details removed.
  • Fixes the Tutorial sidebar order, broken by the separately-merged tectonics tutorial (docs: tectonic rifting and subduction tutorial #89): that PR incidentally bumped couplinggospl.md's sidebar_position from 2 to 8, which combined with the new tectonics.md (position 7) left the sidebar showing A, M, R, V, W, T, C instead of alphabetical order. Reassigns positions 1-7 across all seven Tutorial items: Adaptive mesh refinement with MMG, Coupling with GoSPL, Making a complex mesh with .poly file, Rate-and-state friction (2D), Tectonic rifting and subduction, Velocity boundary conditions (3D), Weak zones.

Test plan

  • yarn build succeeds
  • Checked the generated docs/intro.html to confirm the tip rendered as an admonition
  • Checked the generated category/tutorial.html to confirm the seven items render in alphabetical-by-title order

🤖 Generated with Claude Code

https://claude.ai/code/session_01MyXyjvBfCbpMgZ6ttvJXf3

echoi and others added 3 commits October 29, 2026 19:41
Distilled from a user's account of learning DES3D with an AI coding
assistant (feeding it the docs and background papers, describing a
tectonic scenario in plain language, iterating on the .cfg together).
Written generically, without the original interview's project-specific
or personal details.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01MyXyjvBfCbpMgZ6ttvJXf3
PR #89 (tectonics tutorial) bumped couplinggospl.md's sidebar_position
from 2 to 8 incidentally, which combined with tectonics.md's own
position (7) broke the alphabetical-by-title order set in #97: the
sidebar showed A, M, R, V, W, T, C instead of A, C, M, R, T, V, W.

Reassign positions 1-7 across all seven Tutorial items so they sort
alphabetically by title: Adaptive mesh refinement with MMG, Coupling
with GoSPL, Making a complex mesh with .poly file, Rate-and-state
friction (2D), Tectonic rifting and subduction, Velocity boundary
conditions (3D), Weak zones.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01MyXyjvBfCbpMgZ6ttvJXf3
@echoi
echoi merged commit f7097d6 into main Oct 30, 2026
2 checks passed
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.

1 participant