docs: fix links to match CIP pr

[jcstein]

Overview

Matches celestiaorg/CIPs#269

Summary by CodeRabbit

• Documentation
  • Revised hyperlink formatting in user guides to ensure accurate and consistent references to improvement proposals.
  • Adjusted the display of proposal identifiers (adding leading zeros where needed) to improve clarity and accessibility.
  • Made minor content formatting enhancements to streamline the presentation of information.

[coderabbitai]

Walkthrough

This pull request updates documentation files to correct hyperlink references for Celestia Improvement Proposals. In the how-to-guides, URLs have been reformatted to include leading zeros (e.g., updating CIP-28 from cip-28.html to cip-028.html and similarly for other CIPs). Additionally, a reference in the retrievability guide is corrected from CIP-4 to CIP-004 and an unnecessary empty line is removed.

Changes

File(s)	Change Summary
how-to-guides/mainnet.md how-to-guides/network-upgrade-process.md	Updated multiple CIP hyperlink references to correct URL formatting (e.g., CIP-28 changed to include a leading zero; similar updates made for CIP-10, CIP-17, CIP-25, and CIP-21 to CIP-28).
learn/retrievability.md	Corrected the CIP-4 reference to CIP-004 and removed an extraneous empty line.

Possibly related PRs

• Fix: Update broken links in documentation #1821: Updates CIP-28 and related hyperlinks to align with the new URL format.
• docs: add v3 release notes to ginger upgrade section #1806: Implements similar corrections to CIP hyperlink formatting across documentation.
• docs: add ginger upgrade to docs, update links #1758: Addresses hyperlink updates for various CIPs, including adjustments to ensure consistent URL structures.

Poem

Hoppin' through docs with a joyful beat,
Adjusting CIP links so every URL is neat,
Zeros now lead where they rightly belong,
Keeping details precise like a rhythmic song,
A rabbit’s cheer: (__/), let clarity shine on!

Tip

⚡🧪 Multi-step agentic review comment chat (experimental)

• We're introducing multi-step agentic chat in review comments. This experimental feature enhances review discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments.
  - To enable this feature, set early_access to true under in the settings.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[github-actions]

PR Preview Action v1.6.0
🚀 View preview at https://celestiaorg.github.io/docs-preview/pr-1935/
Built to branch main at 2025-03-17 17:16 UTC. Preview will be ready when the GitHub Pages deployment is complete.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

learn/retrievability.md (1)

21-24: CIP Reference Correction:
The link now correctly points to https://github.com/celestiaorg/CIPs/blob/main/cips/cip-004.md for CIP-4. For increased clarity and consistency, consider updating the link text from CIP-4 to CIP-004 so that both the displayed text and URL match the new format.

how-to-guides/network-upgrade-process.md (1)

31-34: Stylistic Suggestion on CIP-17 Description:
In the sentence "included all of the CIPs listed in CIP-17", consider removing "of" to read "included all CIPs listed in..." for improved conciseness.

🧰 Tools

🪛 LanguageTool

[style] ~33-~33: Consider removing “of” to be more concise
Context: ...The Lemongrass network upgrade included all of the CIPs listed in [CIP-17](https://github....

(ALL_OF_THE)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 381cb28 and adee43c.

📒 Files selected for processing (3)

• how-to-guides/mainnet.md (1 hunks)
• how-to-guides/network-upgrade-process.md (3 hunks)
• learn/retrievability.md (2 hunks)

🧰 Additional context used

🪛 LanguageTool

how-to-guides/network-upgrade-process.md

[style] ~33-~33: Consider removing “of” to be more concise
Context: ...The Lemongrass network upgrade included all of the CIPs listed in [CIP-17](https://github....

(ALL_OF_THE)

🔇 Additional comments (5)

how-to-guides/mainnet.md (1)

41-42: CIP Link Formatting Update:
The hyperlink for CIP-28 now uses cip-028.html (instead of cip-28.html), which aligns with the standard URL formatting across the documentation. Please double-check that all similar CIP links in the repo follow this zero-padded format.

learn/retrievability.md (1)

56-66: Improved Formatting:
The removal of an unnecessary empty line in the bullet list improves the document’s readability and flow. This cleanup is welcome.

how-to-guides/network-upgrade-process.md (3)

11-12: CIP-10 Link Update:
The hyperlink for CIP-10 has been updated to include a leading zero—now cip-010.html—ensuring it is consistent with the new URL formatting guidelines.

---

43-44: CIP-25 and In-protocol Signaling Update:
The text now references CIP-10 correctly and introduces CIP-25 with the adjusted link formatting. This update helps maintain consistency with the overall documentation style.

---

47-52: Consistent CIP References in Bullet List:
The bullet list now correctly lists CIP-21, CIP-24, CIP-26, CIP-27, and CIP-28 with zero-padded URLs. This uniformity across the CIP links greatly enhances reliability and clarity for users.