Skip to content

Commit fda51ea

Browse files
committed
Update CLAUDE.md
1 parent 76e753b commit fda51ea

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

CLAUDE.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,15 @@ When updating documentation:
108108

109109
## Example Tutorial Sync (cosmos/example ↔ this repo)
110110

111-
The Cosmos SDK example chain tutorials live in `sdk/next/tutorials/example/` (files `01-prerequisites.mdx` through `05-run-and-test.mdx`) and are kept in sync with the `cosmos/example` repo via a bidirectional GitHub Actions workflow. When either side merges a change to these files, a PR is automatically opened on the other repo with the content transformed between formats (H1 ↔ frontmatter, absolute ↔ relative links). The transform script lives at `scripts/docs-sync/transform.py` in `cosmos/example`. When editing these tutorial pages, `title:` is always owned by the sync (sourced from the H1 in the example repo) — but any other frontmatter you add here (e.g. `description:`) will be preserved across syncs.
111+
The Cosmos SDK example chain tutorials live in `sdk/next/tutorials/example/` (files `00-overview.mdx` through `05-run-and-test.mdx`) and are kept in sync with the `cosmos/example` repo via a bidirectional GitHub Actions workflow. When either side merges a change to these files, a PR is automatically opened on the other repo with the content transformed between formats (H1 ↔ frontmatter, absolute ↔ relative links).
112+
113+
The transform script exists in two places and must be kept in sync:
114+
- `scripts/docs-sync/transform.py` in **this repo** — used by `.github/workflows/docs-sync-to-example.yml` to transform `.mdx``.md` when syncing to `cosmos/example`
115+
- `scripts/docs-sync/transform.py` in **`cosmos/example`** — used for manual local syncs in both directions
116+
117+
`scripts/docs-sync/` is explicitly unignored in `.gitignore` (the default `scripts/*` rule would otherwise hide it).
118+
119+
When editing these tutorial pages, `title:` is always owned by the sync (sourced from the H1 in the example repo) — but any other frontmatter you add here (e.g. `description:`) will be preserved across syncs.
112120

113121
## Internal Links
114122

0 commit comments

Comments
 (0)