docs: add audits

[jcstein]

Overview

https://celestiaorg.github.io/docs-preview/pr-1990/how-to-guides/audits

Summary by CodeRabbit

• New Features
  • Added a new "Audits" page listing security audits for Celestia-related software, including auditor details and report links.
  • Introduced an "Audits" link in the sidebar under the "Resources" section of the "How-to guides" for easier navigation.

[coderabbitai]

Walkthrough

A new documentation page titled "Audits" has been introduced, providing a centralized table of security audits for various Celestia-related software projects. The sidebar navigation in the documentation configuration has been updated to include an "Audits" link under the "Resources" section within "How-to guides." No changes were made to any exported or public code entities.

Changes

File(s)	Change Summary
.vitepress/config.ts	Added a new sidebar item "Audits" linking to "/how-to-guides/audits" under "Resources" in "How-to guides".
how-to-guides/audits.md	Created a new documentation page listing Celestia software audits, auditors, and links to reports.

Poem

In the warren of docs, a new trail appears,
"Audits" now listed for all bunny peers.
With tables of trust and links to review,
Security hops in, transparent and true.
So nibble these pages, explore every byte—
For Celestia’s code is secure and bright!
🐇🔍✨

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)

• We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.

✨ Finishing Touches

• 📝 Generate Docstrings

---

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.

[Copilot]

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

Comments suppressed due to low confidence (1)

how-to-guides/audits.md:9

• [nitpick] The product name 'v2 celestia-app Lemongrass' may be unclear; consider renaming or adding clarification so it aligns more clearly with the other software names in the list.

| v2 celestia-app Lemongrass | Informal Systems | [Link](https://github.com/celestiaorg/celestia-app/blob/main/docs/audit/informal-systems-v2.pdf) |

[github-actions]

PR Preview Action v1.6.1
Preview removed because the pull request was closed.
2025-04-17 14:31 UTC

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

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

17-20: Consider adding estimated timeframes for TBD audits

For the entries marked as "TBD," it might be helpful to add estimated timeframes or status indicators (e.g., "In progress," "Scheduled for Q2 2024," etc.) to give users an idea of when these audit reports might be available.

-| v4 celestia-app            | TBD              | TBD                                                                                                                        |
-| v5 celestia-app            | TBD              | TBD                                                                                                                        |
-| Shwap                      | OtterSec         | TBD                                                                                                                        |
-| ZK Sync                    | TBD              | TBD                                                                                                                        |
+| v4 celestia-app            | TBD              | Coming soon                                                                                                                |
+| v5 celestia-app            | TBD              | Scheduled                                                                                                                  |
+| Shwap                      | OtterSec         | In progress                                                                                                                |
+| ZK Sync                    | TBD              | Planned                                                                                                                    |

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 5565c29 and 7a9cf90.

📒 Files selected for processing (2)

• .vitepress/config.ts (1 hunks)
• how-to-guides/audits.md (1 hunks)

🔇 Additional comments (3)

.vitepress/config.ts (1)

467-470: LGTM: Well-integrated sidebar navigation entry

The addition of the "Audits" link in the Resources section is properly structured and follows the consistent formatting of the existing sidebar items. This provides users with easy access to the audit information.

how-to-guides/audits.md (2)

1-4: LGTM: Clear and concise introduction

The title and introduction clearly explain the purpose of the page, providing users with context about the audits documentation.

---

5-16: LGTM: Well-structured audit information

The table format provides a clean and organized way to present the audit information, with appropriate columns for Software, Auditor, and Links. The links to audit reports are correctly formatted.