Skip to content

chore(docs): adopt sync-docs-action v0.3.0 and emit the nested nav#197

Merged
mmanciop merged 1 commit into
mainfrom
docs/adopt-nested-nav
Jul 17, 2026
Merged

chore(docs): adopt sync-docs-action v0.3.0 and emit the nested nav#197
mmanciop merged 1 commit into
mainfrom
docs/adopt-nested-nav

Conversation

@mmanciop

@mmanciop mmanciop commented Jul 16, 2026

Copy link
Copy Markdown
Member

Summary

  • Pin the sync workflow to `dash0hq/sync-docs-action@v0.3.0` (SHA `de42352`).
  • Re-add the `nav:` block; the v0.3.0 engine now derives the nested tree from `target:` paths, so the emitted `nav.json` matches the shape dash0-website currently maintains by hand.
  • Retarget every file under `dash0/miscellaneous/tooling/dash0-cli/` so files land where dash0-website already renders them and the nav's `path` entries line up.
  • Publish the two action READMEs (`.github/actions/setup/README.md`, `.github/actions/send-log-event/README.md`) as `github-actions/setup.md` and `github-actions/send-log-event.md`.
  • Slim `docs/github-actions.md` to a 5-line landing (matches the site's existing `github-actions/about.md`). Contributor-side "keeping the actions in sync" and "testing the setup action" content moves into a new `docs/github-actions-maintenance.md` (not synced); CLAUDE.md's guidelines list is updated.

- Pin the sync workflow to sync-docs-action v0.3.0
  (SHA de42352c0e212c770c6e91cf85993c7e76f5a8b9); update the dry-run
  fallback's SYNC_DOCS_ACTION_REF to match.
- Re-add the `nav:` block, this time driving the nested tree the
  website expects: `Tooling → Dash0 CLI → files`, with a `GitHub
  Actions` subgroup pulling in the two composite-action READMEs as
  subpages. The `nav.groupTitles` map turns the `github-actions`
  directory slug into the "GitHub Actions" display title.
- Rewrite every `target:` under `dash0/miscellaneous/tooling/dash0-cli/`
  so files land where dash0-website already renders them and the
  emitted `nav.json` paths line up with the (until now hand-maintained)
  file at that same location.
- Publish `.github/actions/setup/README.md` and
  `.github/actions/send-log-event/README.md` as `github-actions/setup.md`
  and `github-actions/send-log-event.md` so the "GitHub Actions" group
  has real leaves.
- Slim `docs/github-actions.md` to a 5-line landing page (matches what
  dash0-website already renders at `github-actions/about.md`). The
  contributor-facing "keeping the actions in sync" and "testing the
  setup action" content moves to a new, un-synced
  `docs/github-actions-maintenance.md`, and CLAUDE.md's guidelines list
  is updated to point at it.
@mmanciop
mmanciop merged commit f3c4a78 into main Jul 17, 2026
67 of 69 checks passed
@mmanciop
mmanciop deleted the docs/adopt-nested-nav branch July 17, 2026 08:08
@github-actions github-actions Bot locked and limited conversation to collaborators Jul 17, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant