docs: add shwap audit

[jcstein]

Overview

Summary by CodeRabbit

• Documentation
  • Updated the "Shwap" audit entry to include a direct link to the draft audit report.
  • Removed a duplicate placeholder entry for "Shwap" to consolidate information.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The changes update the audits documentation by replacing a placeholder entry for the "Shwap" audit with a direct link to a draft audit report. Additionally, a duplicate placeholder entry for "Shwap" was removed, consolidating the information into a single, linked entry.

Changes

File(s)	Change Summary
how-to-guides/audits.md	Updated "Shwap" audit entry from "TBD" to a direct report link and removed duplicate entry.

Possibly related PRs

• docs: add audits #1990: Updated and initially added the audit entry for "Shwap" in the audits documentation, which is directly refined by this PR.

Suggested labels

documentation

Poem

In the warren of docs, a change hops by,
No more "TBD"—we link to the sky!
The Shwap audit now easy to find,
With duplicates gone, it’s neatly aligned.
🐇✨
A hop, a link, a tidy new track—
The audit trail’s clear, no need to look back!

---

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 0cbba6c and 57d6ea1.

⛔ Files ignored due to path filters (1)

• public/audits/celestia_shwap_audit_draft.pdf is excluded by !**/*.pdf

📒 Files selected for processing (1)

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

---

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 generate sequence diagram to generate a sequence diagram of the changes in 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]

Pull Request Overview

This PR updates the audits documentation by replacing the placeholder entry for the Shwap audit with an actual link to a draft audit document.

• Replaces the "TBD" Shwap audit entry with a link to the audit draft
• Removes the duplicate placeholder row for the Shwap audit

Comments suppressed due to low confidence (1)

how-to-guides/audits.md:17

• Confirm that the new Shwap audit entry with the provided link is the intended final version and that it correctly replaces the previous placeholder entry.

+| Shwap                      | OtterSec         | [Link](https://docs.celestia.org/audits/celestia_shwap_audit_draft.pdf)|

[github-actions]

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