0xMiden / 0xMiden/docs

docs: update references for miden-base → protocol and miden-node → node repo renames

Offen Anfängerfreundlich
#175 0 Kommentare 0 Reaktionen 1 zugewiesene Person Beansprucht von @BrianSeong99 Auf GitHub ansehen
Vorherrschende Sprache
TypeScript
Sterne
10
Forks
50
Ø Merge
22 T. 23 Std.
Gemergte PRs (30 T.)
1

Beschreibung

Two repos have been renamed:
- `miden-base` → `protocol`
- `miden-node` → `node`

The docs still reference the old names in ~86 files across URLs, prose, CI workflows, config, and internal links.

## Scope breakdown

| Area | miden-base | miden-node |
|------|-----------|-----------|
| Active docs (`docs/`) | 8 files | 1 file |
| Versioned docs | ~20 files | ~15 files |
| CI workflows | 2 files (~20 lines each) | 2 files (~20 lines each) |
| Config (docusaurus, sidebars, release-manifest) | 3 files | 3 files |
| README | 1 file | 1 file |

## Key areas

- GitHub URLs (`0xMiden/miden-base` → `0xMiden/protocol`, `0xMiden/miden-node` → `0xMiden/node`)
- Internal doc links (`/design/miden-base/` → `/design/protocol/`, `/design/miden-node/` → `/design/node/`)
- Directory names under `docs/design/` and `versioned_docs/`
- CI workflow env vars and checkout steps
- `release-manifest.yml` repo keys
- `docusaurus.config.ts` redirect rules
- `sidebars.ts` comments

## Note

Versioned docs snapshots (v0.11, v0.12) may keep old names since they reflect historical state.

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

The issue lists the files to update, including docs/, versioned_docs/, CI workflows, and config files like docusaurus.config.ts and sidebars.ts. Start by searching for 'miden-base' and 'miden-node' in the repository to locate all occurrences. Focus on updating GitHub URLs, internal doc links, directory references, and CI workflow steps. Verify changes by building the docs locally to ensure links work correctly.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
typescript
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Aktivitätsstatus
Veraltet
Klarheit
Klar beschrieben
Anfängerfreundlichkeit
70/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.