Skip to content

Restructure documentation into topical folders#2963

Merged
juliusmarminge merged 2 commits into
mainfrom
feature/docs-restructure
Jun 5, 2026
Merged

Restructure documentation into topical folders#2963
juliusmarminge merged 2 commits into
mainfrom
feature/docs-restructure

Conversation

@juliusmarminge
Copy link
Copy Markdown
Member

@juliusmarminge juliusmarminge commented Jun 5, 2026

Summary

  • Reorganized the project documentation into topical folders under docs/ for easier discovery.
  • Added a docs/README.md landing page that groups the docs by area.
  • Updated top-level and moved-document links to point at the new paths.
  • Consolidated cloud, operations, getting started, reference, user, mobile, and project docs into clearer locations.

Testing

  • Not run
  • Documentation-only reorganization; no runtime code changes were made.

Note

Low Risk
Documentation-only path and link updates with no runtime, auth, or data-handling changes.

Overview
Reorganizes project documentation into topical folders under docs/ (getting started, architecture, cloud, operations, providers, reference, user guides, etc.) and adds docs/README.md as a grouped landing page.

The root README.md now points observability, relay, and Clerk docs at the new paths and adds a Documentation section with links into the reorganized tree. docs/operations/ci.md links the release checklist with a relative path; docs/user/keybindings.md fixes cross-repo links to packages/contracts and apps/server after the move.

No application or server code changes—link and layout updates only.

Reviewed by Cursor Bugbot for commit efbb59d. Bugbot is set up for automated code reviews on this repo. Configure here.

Note

Restructure documentation into topical folders under docs/

Moves ~25 documentation files from flat or scattered locations into a consistent topic-based hierarchy under docs/, with subdirectories for architecture/, cloud/, getting-started/, integrations/, mobile/, operations/, reference/, and user/. Adds a docs/README.md index linking all sections, and updates README.md with a new Documentation section. A few internal relative links (e.g. in docs/user/keybindings.md and docs/operations/ci.md) are updated to reflect new paths. No content changes are made to any document.

Macroscope summarized efbb59d.

- Move scattered docs into `docs/*` sections
- Add a docs landing page and update internal links
- Keep README pointers aligned with the new layout
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Jun 5, 2026

Important

Review skipped

Auto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: b9bdc2c1-1d5b-4e3c-a083-fede71e9fd0d

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feature/docs-restructure

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

@github-actions github-actions Bot added vouch:trusted PR author is trusted by repo permissions or the VOUCHED list. size:M 30-99 changed lines (additions + deletions). labels Jun 5, 2026
@juliusmarminge juliusmarminge merged commit ec18938 into main Jun 5, 2026
15 of 16 checks passed
@juliusmarminge juliusmarminge deleted the feature/docs-restructure branch June 5, 2026 03:03
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jun 5, 2026

🚀 Expo continuous deployment is ready!

  • Project → t3-code
  • Platforms → android, ios
  • Scheme → t3code-preview
  🤖 Android 🍎 iOS
Fingerprint 50af7188c45504c4cf76a4d9ba23a0d6e9b94177 4979c8b8257a78fdd342fea35340fe3b4121e5dc
Build Details Build Permalink
DetailsDistribution: INTERNAL
Build profile: preview:dev
Runtime version: 50af7188c45504c4cf76a4d9ba23a0d6e9b94177
App version: 0.1.0
Git commit: ec3667f57deb1ef6b17a60211eb4815488dee1bf
Build Permalink
DetailsDistribution: INTERNAL
Build profile: preview:dev
Runtime version: 4979c8b8257a78fdd342fea35340fe3b4121e5dc
App version: 0.1.0
Git commit: ec3667f57deb1ef6b17a60211eb4815488dee1bf
Update Details Update Permalink
DetailsBranch: pr-2963
Runtime version: 50af7188c45504c4cf76a4d9ba23a0d6e9b94177
Git commit: 7cd9d1621d164f201cdce86cbbbf747fb84b52ec
Update Permalink
DetailsBranch: pr-2963
Runtime version: 4979c8b8257a78fdd342fea35340fe3b4121e5dc
Git commit: 7cd9d1621d164f201cdce86cbbbf747fb84b52ec
Update QR

Jaaneek pushed a commit to Jaaneek/t3code that referenced this pull request Jun 5, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size:M 30-99 changed lines (additions + deletions). vouch:trusted PR author is trusted by repo permissions or the VOUCHED list.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant