Skip to content

fix: update references to renamed repositories #201

@Keinberger

Description

@Keinberger

Several repos got renamed (miden-tutorials -> tutorials, miden-node -> node, miden-base -> protocol, miden-docs -> docs). GitHub redirects still work for now but they're not permanent, and the CI workflows reference old names directly in repository: fields. Once redirects go away, builds break.

miden-client, compiler, and miden-vm are unchanged.

Workflows

Both deploy-docs.yml and cut-versions.yml need the same set of changes:

  • repository: fields in the actions/checkout steps (0xMiden/miden-base, 0xMiden/miden-node, 0xMiden/miden-tutorials)
  • Env vars in cut-versions.yml (REPO_NODE, REPO_BASE, REPO_TUTORIALS)
  • JS manifest key lookups in cut-versions.yml (refs['miden-node'], refs['miden-base'], refs['miden-tutorials'])
  • Input descriptions, step names, echo statements, comments

The vendor paths (vendor/miden-base, etc.) and aggregation scripts reference these same directory names throughout both files. If vendor dirs get renamed, every path reference in the shell scripts needs to change in lockstep.

Release Manifest

.release/release-manifest.yml has keys miden-base, miden-node, miden-tutorials that get parsed by the JS in cut-versions.yml. Both files need to be updated together, otherwise the getRef function silently falls back to "main" for missing keys.

Config & Docs

  • docusaurus.config.ts line 23: projectName: "miden-docs" (used for "Edit this page" links)
  • README.md: Mermaid diagram nodes, content ownership tables, contributor reference table, prose throughout
  • static/skill.md: repo names in the skill description

What to leave alone

versioned_docs/ has 69 files across v0.11, v0.12, v0.13 with old repo URLs. These are frozen snapshots and should stay as-is. GitHub redirects cover them, and if those ever break it's a simple batch find-replace.

docs/ (current version) is clean, 0 matches.

No custom secrets or repository variables are referenced in either workflow.

Open Questions

  1. Vendor directory naming - rename vendor/miden-base to vendor/protocol etc., or keep the old names as local aliases? Cosmetic but keeps things consistent.
  2. docs/core-concepts/miden-base/ and docs/core-concepts/miden-node/ - these show up in live site URLs. Renaming them changes URLs and breaks external bookmarks. Probably a separate issue?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions