Skip to content

add(docs): contributor naming conventions doc#1931

Merged
kotAPI merged 1 commit into
mainfrom
kotapi/naming-conventions-doc
May 5, 2026
Merged

add(docs): contributor naming conventions doc#1931
kotAPI merged 1 commit into
mainfrom
kotapi/naming-conventions-doc

Conversation

@kotAPI

@kotAPI kotAPI commented May 5, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • add a contributor-facing naming conventions page under /docs/contributing
  • document naming patterns for component folders, entry files, fragments, contexts, hooks, tests, stories, primitives, and docs routes
  • link the new page from the contributing navigation and Before You Start

Why

  • makes existing repo naming rules explicit for contributors
  • keeps this guidance in developer docs rather than consumer-facing component docs
  • clarifies current conventions and calls out the existing context/ vs contexts/ transition without doing unrelated renames

Validation

  • pnpm exec eslint app/docs/docsNavigationSections.tsx app/docs/contributing/naming-conventions/page.tsx app/docs/contributing/naming-conventions/seo.ts
  • attempted pnpm build in docs/

Build blocker

  • pnpm build currently fails on unrelated existing docs errors in app/docs/components/toast/docs/example_action.tsx and related toast example files because @radui/ui/Toast is not exported from the package used by the docs app

Risks / follow-ups

  • the repo still contains both context/ and contexts/; this PR documents the preferred convention for new work but does not rename existing folders

Closes #1831

Summary by CodeRabbit

  • Documentation
    • Added comprehensive naming conventions documentation for contributors, covering casing standards, folder and file structures, component organization, hook and context naming, and test file naming patterns
    • Updated the contributing guide to include a prerequisite link to the new naming conventions documentation
    • Added the naming conventions page to the main documentation navigation menu

@changeset-bot

changeset-bot Bot commented May 5, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 3f5d583

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@coderabbitai

coderabbitai Bot commented May 5, 2026

Copy link
Copy Markdown
Contributor

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: c4c2286c-9bb8-499e-bc7e-8ec8227fdb7d

📥 Commits

Reviewing files that changed from the base of the PR and between e90b02a and 3f5d583.

📒 Files selected for processing (5)
  • docs/app/docs/contributing/before-you-start/content.mdx
  • docs/app/docs/contributing/naming-conventions/content.mdx
  • docs/app/docs/contributing/naming-conventions/page.tsx
  • docs/app/docs/contributing/naming-conventions/seo.ts
  • docs/app/docs/docsNavigationSections.tsx

📝 Walkthrough

Walkthrough

Documentation for naming conventions is introduced as a comprehensive contributor guide covering folder/file structures, component patterns, contexts/providers/hooks, and test/story naming. The guide is integrated into the contributing docs navigation and linked from the "Before submitting" prerequisite section.

Changes

Naming Conventions Documentation

Layer / File(s) Summary
Documentation Content
docs/app/docs/contributing/naming-conventions/content.mdx
Comprehensive naming conventions guide covering general casing rules, UI component folder/file structures, context/provider/hook naming, primitives vs UI components, test/story file naming patterns, docs route naming, and a quick-reference checklist.
Page Setup & Metadata
docs/app/docs/contributing/naming-conventions/page.tsx, docs/app/docs/contributing/naming-conventions/seo.ts
Page wrapper using createDocsPage and SEO metadata generated for "Naming conventions | Rad UI".
Navigation Integration
docs/app/docs/docsNavigationSections.tsx
"Naming Conventions" item added under Contributing category pointing to /docs/contributing/naming-conventions.
Cross-linking
docs/app/docs/contributing/before-you-start/content.mdx
New prerequisite bullet added linking to naming conventions before submitting first contribution.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

  • rad-ui/ui#723: Both PRs modify the "Before You Start" contributing documentation, with this PR adding a naming-conventions link while the other updates the before-you-start page structure.

Suggested labels

automerge

Poem

🐰 Conventions now clear and bright,
Folders and files named just right,
Contributors skip no beat—
Naming patterns, crisp and neat!
Rad UI's guide, complete!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'add(docs): contributor naming conventions doc' clearly and concisely summarizes the main change—adding documentation about naming conventions for contributors.
Linked Issues check ✅ Passed The PR addresses all coding requirements from issue #1831: documents naming conventions for folders, files, contexts, and hooks with examples; updates contributor docs navigation; and defers enforcement, meeting all acceptance criteria.
Out of Scope Changes check ✅ Passed All changes are scoped to adding and integrating the naming conventions documentation; no unrelated code modifications or refactoring are present.
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 kotapi/naming-conventions-doc

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

@kotAPI kotAPI changed the title Add contributor naming conventions doc add(docs): contributor naming conventions doc May 5, 2026
@kotAPI kotAPI merged commit 0b75501 into main May 5, 2026
6 of 11 checks passed
@kotAPI kotAPI deleted the kotapi/naming-conventions-doc branch May 5, 2026 02:49
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.

Add naming conventions document for folders/files/contexts.

1 participant