adding audit template

[sbvegan]

Description

I'm going to use this issue template for running through the technical documentation audit.

[coderabbitai]

Walkthrough

A new template file, docs_audit_results.md, has been introduced for conducting formal technical documentation audits within OP Labs. This template provides a structured framework for evaluating documentation, identifying necessary updates, and managing tasks based on urgency and impact. It includes sections for content evaluation, priority labeling, T-shirt sizing for task complexity, and metadata tagging to enhance documentation organization. Additionally, minor updates were made to existing documentation links for accuracy.

Changes

File Path	Change Summary
.github/ISSUE_TEMPLATE/docs_audit_results.md	Added a template for documentation audits, including sections for updates, evaluation criteria, priority labels, and metadata tags.
pages/builders/chain-operators/configuration/rollup.mdx	Updated the hyperlink for the "Deputy Guardian Module" to point to the correct documentation.
pages/stack/protocol/fault-proofs/fp-components.mdx	Removed a query parameter from the link to the Immunefi bug bounty page for clarity.

Sequence Diagram(s)

sequenceDiagram
    participant A as Auditor
    participant B as Documentation
    participant C as OP Labs Team

    A->>B: Review documentation
    B-->>A: Provide current state
    A->>A: Identify necessary updates
    A->>C: Assign priority labels
    C->>A: Allocate resources based on urgency
    A->>B: Suggest revisions and improvements

Loading

---

Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 17af7cf and 1139eab.

Files selected for processing (3)

• .github/ISSUE_TEMPLATE/docs_audit_results.md (1 hunks)
• pages/builders/chain-operators/configuration/rollup.mdx (1 hunks)
• pages/stack/protocol/fault-proofs/fp-components.mdx (1 hunks)

Files skipped from review due to trivial changes (2)

• pages/builders/chain-operators/configuration/rollup.mdx
• pages/stack/protocol/fault-proofs/fp-components.mdx

Files skipped from review as they are similar to previous changes (1)

• .github/ISSUE_TEMPLATE/docs_audit_results.md

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 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.

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.

[netlify]

✅ Deploy Preview for docs-optimism ready!

Name	Link
🔨 Latest commit	1139eab
🔍 Latest deploy log	https://app.netlify.com/sites/docs-optimism/deploys/66e19cf567a9ef0008f6ba1b
😎 Deploy Preview	https://deploy-preview-891--docs-optimism.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.