Skip to content
This repository was archived by the owner on Aug 7, 2025. It is now read-only.

chore: fix titles #599

Merged
tac0turtle merged 1 commit into from
Jul 18, 2025
Merged

chore: fix titles #599

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions .vitepress/config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -209,14 +209,14 @@ function sidebarHome() {
text: "Technical Specifications",
collapsed: true,
items: [
{ text: "overview", link: "/learn/specs/overview" },
{ text: "block-manager", link: "/learn/specs/block-manager" },
{ text: "block-validity", link: "/learn/specs/block-validity" },
{ text: "da", link: "/learn/specs/da" },
{ text: "full_node", link: "/learn/specs/full_node" },
{ text: "header-sync", link: "/learn/specs/header-sync" },
{ text: "p2p", link: "/learn/specs/p2p" },
{ text: "store", link: "/learn/specs/store" },
{ text: "Overview", link: "/learn/specs/overview" },
{ text: "Block Manager", link: "/learn/specs/block-manager" },
{ text: "Block Validity", link: "/learn/specs/block-validity" },
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot Jul 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The new title "Block Validity" is less precise than the title of the document it links to. The file learn/specs/block-validity.md is titled "# Block and Header Validity" and covers both topics. To maintain consistency and avoid confusion, it's best to use the full title from the document.

Suggested change
{ text: "Block Validity", link: "/learn/specs/block-validity" },
{ text: "Block and Header Validity", link: "/learn/specs/block-validity" },

{ text: "Data Availability", link: "/learn/specs/da" },
{ text: "Full Node", link: "/learn/specs/full_node" },
{ text: "Header Sync", link: "/learn/specs/header-sync" },
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot Jul 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The title "Header Sync" doesn't fully represent the content of the linked document. The file learn/specs/header-sync.md is titled "# Header and Data Sync" and discusses both. For better accuracy and consistency, I recommend using the document's full title in the sidebar.

Suggested change
{ text: "Header Sync", link: "/learn/specs/header-sync" },
{ text: "Header and Data Sync", link: "/learn/specs/header-sync" },

{ text: "P2P", link: "/learn/specs/p2p" },
{ text: "Store", link: "/learn/specs/store" },
],
},
],
Expand Down