Skip to content

Update titles and plan for Project Labels#425

Merged
sriramveeraghanta merged 2 commits intomasterfrom
fix-plan-and-headings
Apr 2, 2026
Merged

Update titles and plan for Project Labels#425
sriramveeraghanta merged 2 commits intomasterfrom
fix-plan-and-headings

Conversation

@danciaclara
Copy link
Copy Markdown
Collaborator

@danciaclara danciaclara commented Apr 2, 2026

Summary by CodeRabbit

  • Documentation
    • Streamlined and clarified navigation labels throughout the documentation sidebar for improved consistency
    • Simplified page headings across documentation pages for better clarity and scannability
    • Updated naming conventions to better reflect feature names (e.g., "Workflow States" → "Work Item States", "Build custom dashboards" → "Dashboards")
    • Adjusted badge classifications for accurate feature tier information

Summary by CodeRabbit

  • Documentation
    • Clarified and made sidebar navigation labels more specific while preserving targets
    • Standardized and simplified top-level page headings across many docs for clarity and scannability
    • Updated several page titles to better reflect feature names (e.g., “Workflow States” → “Work Item States”, “Overview” → “Intake Overview”)
    • Adjusted a badge classification for one page to reflect the appropriate feature tier

@vercel
Copy link
Copy Markdown

vercel bot commented Apr 2, 2026

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

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment Apr 2, 2026 1:21pm

Request Review

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 2, 2026

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: e5788332-00e6-4663-85ca-f12555ce0a21

📥 Commits

Reviewing files that changed from the base of the PR and between f26eb21 and 52cca49.

📒 Files selected for processing (1)
  • docs/.vitepress/config.ts

📝 Walkthrough

Walkthrough

This PR updates headings and VitePress sidebar labels across documentation files to standardize and shorten titles (e.g., "Workflow States" → "Work Item States", importer pages to "X importer", several integration and feature headings). Changes are text-only; no structural or behavioral edits.

Changes

Cohort / File(s) Summary
VitePress Navigation Configuration
docs/.vitepress/config.ts
Adjusted sidebar item text values (labels) to clearer wording while keeping the same link targets and order.
AI & Analytics Documentation
docs/ai/pi-chat.md, docs/ai/plane-ai-credits.md, docs/core-concepts/analytics.md, docs/core-concepts/inbox.md
H1 updates: e.g., "AI-powered assistant for Plane" → "Plane AI"; "How Plane AI credits work" → "Plane AI credits"; "View analytics at different levels" → "Analytics"; "Get in-app notifications" → "Inbox".
Core Concepts & Collaboration
docs/core-concepts/intake.md, docs/core-concepts/issues/states.md, docs/core-concepts/issues/plane-query-language.md, docs/core-concepts/pages/inline-comments.md, docs/core-concepts/projects/project-labels.md, docs/core-concepts/projects/project-states.md, docs/communication-and-collaboration/comments-and-activity.md, docs/communication-and-collaboration/project-updates.md
Standardized and capitalized headings (e.g., "Workflow States" → "Work Item States", various project and comments headings; PQL label addition).
Importers Documentation
docs/importers/overview.md, docs/importers/asana.md, docs/importers/clickup.md, docs/importers/confluence.md, docs/importers/csv.md, docs/importers/flatfile.md, docs/importers/jira.md, docs/importers/linear.md, docs/importers/notion.md
Renamed importer pages to consistent "X importer" or "Import data" headings; minor punctuation/label tweaks.
Integrations Documentation
docs/integrations/about.md, docs/integrations/draw-io.md, docs/integrations/github.md, docs/integrations/gitlab.md, docs/integrations/sentry.md, docs/integrations/slack.md
Unified integration page headings to "X Integration" and renamed integrations overview to "Native Integrations".
Intake & Customer Management
docs/intake/overview.md, docs/intake/intake-email.md, docs/intake/intake-forms.md, docs/customers.md
Normalized intake-related H1s ("Intake Overview", "Intake Email", "Intake Forms") and simplified customers heading.
Additional Feature Documentation
docs/dashboards.md, docs/devices/mobile.md
Shortened headings to "Dashboards" and "Plane Mobile App".

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Suggested reviewers

  • sriramveeraghanta

Poem

🐰 Hop, hop — I hopped through headings bright,
Shortened titles, made them light.
Importers tidy, integrations neat,
Sidebar labels all in a row so sweet.
Cheers — a rabbit’s small delight!

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Title check ⚠️ Warning The title refers to a real part of the changeset—updating the Project Labels page heading and badge—but is incomplete as the PR comprises 33 files with widespread heading/label updates across multiple documentation sections. Revise the title to reflect the primary scope, such as 'Standardize documentation heading capitalization and styling' or 'Simplify documentation page titles across multiple sections' to accurately represent the comprehensive nature of these changes.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ 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 fix-plan-and-headings

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.

@sriramveeraghanta sriramveeraghanta merged commit c467a3d into master Apr 2, 2026
4 checks passed
@sriramveeraghanta sriramveeraghanta deleted the fix-plan-and-headings branch April 2, 2026 13:22
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