update audit issue template

[sbvegan]

Adding guidance comments to the issue template for running this audit

[netlify]

✅ Deploy Preview for docs-optimism ready!

Name	Link
🔨 Latest commit	51082cd
🔍 Latest deploy log	https://app.netlify.com/sites/docs-optimism/deploys/6725546e72cd7b00082a16c2
😎 Deploy Preview	https://deploy-preview-1068--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.

[coderabbitai]

Walkthrough

The pull request introduces structural modifications to the .github/ISSUE_TEMPLATE/docs_audit_results.md file. Key changes include the addition of new sections such as "Acceptance criteria," "Resources," and "Action items," which enhance the template's clarity and organization. The previous directive for users to describe the current state of the page has been changed to a comment. Existing sections remain intact but are better contextualized within the overall template, improving usability for documentation audits.

Changes

File	Change Summary
.github/ISSUE_TEMPLATE/docs_audit_results.md	- Updated template name to Docs audit results
	- Added section: ### Acceptance criteria
	- Added section: ### Resources
	- Added section: ### Action items
	- Converted directive to comment for describing the current state of the page
	- Existing sections on labels, priority, T-shirt size, content evaluation, and MDX metadata format preserved and contextualized

Possibly related PRs

• adding audit template #891: This PR introduces the docs_audit_results.md template, which is directly related to the changes made in the main PR that enhance the structure and clarity of the same template.
• adding the content eval back #916: This PR adds a "Content evaluation" section to the docs_audit_results.md file, which aligns with the main PR's focus on improving the organization and usability of the template.
• formatting the page header thing #893: This PR adds a new Markdown section within the docs_audit_results.md file, contributing to the overall structural improvements that the main PR aims to achieve.

Suggested reviewers

• bradleycamacho

---

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>, 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 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.

[coderabbitai]

Actionable comments posted: 3

🧹 Outside diff range and nitpick comments (1)

.github/ISSUE_TEMPLATE/docs_audit_results.md (1)

12-13: Enhance description guidance for better clarity

While converting the text to a comment improves the template format, consider adding more specific guidance about what should be included in the description, such as:

• Current technical accuracy
• Content structure issues
• Outdated information
• Missing topics

-<!-- Write a description of the current state of the page. -->
+<!-- Describe the current state of the page, including:
+- Technical accuracy of existing content
+- Structure and organization issues
+- Outdated information or broken links
+- Missing or incomplete topics
+-->

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 51001fa and 51082cd.

📒 Files selected for processing (1)

• .github/ISSUE_TEMPLATE/docs_audit_results.md (1 hunks)