docs: rename Core Concepts to Reference (label + paths)#306
Merged
Conversation
Completes the rename beyond the visible label by moving the section directories and updating every path reference: - git mv docs/core-concepts -> docs/reference, plus the v0.13 and v0.14 versioned snapshots. - Update sidebars (current + all versioned: dirName and the coreConceptsSidebar -> referenceSidebar id), navbar/footer links, OG pathPrefixes, and the ingestion/cleanup paths in cut-versions.yml and deploy-docs.yml. - Update builder cross-links across current and versioned docs, plus llms.txt, skill.md, README and CLAUDE. Add /core-concepts/* -> /reference/* redirects (current, /next, and versioned) so existing URLs and bookmarks keep working. Guardian's nested core-concepts/ subsection, private-multisig/core-concepts, the miden-architecture-core-concepts.gif asset, and the old v0.11/v0.12 miden-base content are intentionally preserved.
BrianSeong99
changed the title
The blanket core-concepts -> reference replace also hit legacy alias links in v0.13 builder content. Absolute /core-concepts/miden-base/* links (which resolved to the current version via a redirect) became /reference/miden-base/* with no redirect, and one /core-concepts/miden-node link became /reference/miden-node. Point them at the canonical /reference/protocol/* and /reference/node/* targets. Relative links into v0.13's own reference/miden-base/ are left untouched (they resolve correctly within the version).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Renames the top-level docs section from Core Concepts to Reference — both the visible label and the underlying
/core-concepts/…→/reference/…paths.Per #286 the path change was deferred ("unless separately approved"); that approval is now given, so this PR carries it through.
Changes
Label: navbar, footer, sidebar labels, landing page, 404 copy, README,
llms.txt,skill.md, OG card text — current + v0.13/v0.14.Paths/folders:
git mv docs/core-concepts → docs/reference, plus the v0.13 and v0.14 versioned snapshots.dirNameand thecoreConceptsSidebar→referenceSidebarid, so every version's nav resolves).pathPrefixes, and the ingestion/cleanup paths incut-versions.ymlanddeploy-docs.yml./core-concepts/* → /reference/*for current,/next, and versioned — existing URLs and bookmarks keep working.Intentionally preserved (not renamed)
builder/miden-guardian/core-concepts/subsection.builder/private-multisig/core-concepts.md.miden-basecontent; the protocol overview's own## Core conceptsheading +miden-architecture-core-concepts.gif./core-concepts/*redirect sources and thecore-concepts.pngOG filename (functional).Verification
Built locally with a full CI-style ingestion of all 7 source repos at deploy refs (protocol, miden-vm, node, compiler, tutorials, miden-client, note-transport-service):
[SUCCESS]. Sidebar ids consistent across all 5 versions; all versioned sidebar JSON valid..md/relative link-normalization issues (tracked separately in fix: make docs links resolve consistently regardless of URL form #262), broken onmaintoday and unaffected by this rename./reference/*pages return 200 and legacy/core-concepts/*URLs redirect correctly.miden-base/miden-nodealias links (commit fixes them to canonical/reference/protocoland/reference/node).Merged latest
main.Closes #286.