Skip to content

Report a published page#440

Merged
sriramveeraghanta merged 3 commits intomasterfrom
report-published-pages
Apr 24, 2026
Merged

Report a published page#440
sriramveeraghanta merged 3 commits intomasterfrom
report-published-pages

Conversation

@danciaclara
Copy link
Copy Markdown
Collaborator

@danciaclara danciaclara commented Apr 24, 2026

Summary by CodeRabbit

Documentation

  • Added comprehensive guide on reporting publicly published Plane pages, including step-by-step access instructions, available reporting categories, submission methods via the page menu or email, and post-report review and handling expectations.

@vercel
Copy link
Copy Markdown

vercel Bot commented Apr 24, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment Apr 24, 2026 0:18am

Request Review

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 24, 2026

📝 Walkthrough

Walkthrough

Adds a new navigation link in the VitePress configuration to a documentation page about reporting publicly published Plane pages. The new documentation page provides step-by-step instructions for users to report content violations and outlines disallowed content categories and post-report handling expectations.

Changes

Cohort / File(s) Summary
Documentation and Navigation Configuration
docs/.vitepress/config.ts, docs/pages/report-page.md
Adds a new sidebar navigation link to reference a new report page under the "Knowledge management" section. Creates comprehensive documentation explaining the reporting process, violation categories, and post-report outcomes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A report page hops into place,
Safe spaces need a helping grace,
With links aligned and docs so clear,
User voices safety will hear!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title 'Report a published page' clearly describes the main change: adding documentation and UI navigation for the page reporting feature.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch report-published-pages

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

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Nitpick comments (1)
docs/pages/report-page.md (1)

29-29: Consider making the email address clickable.

For better user experience, you could make the email address a mailto link:

📧 Proposed improvement
-If you can't access the report option - for example, the page has already been taken down, or you're reporting on behalf of a security team - email **security@plane.so** with:
+If you can't access the report option - for example, the page has already been taken down, or you're reporting on behalf of a security team - email [security@plane.so](mailto:security@plane.so) with:
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/pages/report-page.md` at line 29, The email address in the report copy
should be turned into a clickable mailto link to improve UX; update the text
that currently contains "security@plane.so" in the report-page content so it
uses a Markdown mailto link (e.g.,
[security@plane.so](mailto:security@plane.so)) or an equivalent HTML anchor,
ensuring the visible text remains the email address and the href is
"mailto:security@plane.so".
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/pages/report-page.md`:
- Line 1: The file docs/pages/report-page.md fails the oxfmt format check; run
the project formatting command (pnpm fix:format) locally and commit the
resulting changes so the file passes pnpm check:format in CI; specifically
reformat docs/pages/report-page.md (and any other unstaged files) with the
oxfmt/prettier config and re-run the formatter to ensure CI passes.

---

Nitpick comments:
In `@docs/pages/report-page.md`:
- Line 29: The email address in the report copy should be turned into a
clickable mailto link to improve UX; update the text that currently contains
"security@plane.so" in the report-page content so it uses a Markdown mailto link
(e.g., [security@plane.so](mailto:security@plane.so)) or an equivalent HTML
anchor, ensuring the visible text remains the email address and the href is
"mailto:security@plane.so".
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 618649ac-c62d-40c8-ae88-c3ce93516bb0

📥 Commits

Reviewing files that changed from the base of the PR and between 6e97b2b and 5ff6dc5.

📒 Files selected for processing (2)
  • docs/.vitepress/config.ts
  • docs/pages/report-page.md

Comment thread docs/pages/report-page.md
@sriramveeraghanta sriramveeraghanta merged commit 3c76435 into master Apr 24, 2026
5 checks passed
@sriramveeraghanta sriramveeraghanta deleted the report-published-pages branch April 24, 2026 12:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants