Skip to content

docs: Add modes to all explanation/how to #13922

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: Add modes to all explanation/how to #13922

wants to merge 1 commit into from

Conversation

brophdawg11
Copy link
Contributor

Add's a MODES bar to all docs in the Explanation/How To sections that didn't already have one

@changeset-bot changeset-bot
Copy link

changeset-bot bot commented Jul 2, 2025 •
edited
Loading

⚠️ No Changeset found

Latest commit: 1939905

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

brophdawg11
brophdawg11 commented Jul 2, 2025
View reviewed changes
docs/explanation/code-splitting.md
Comment on lines -9 to +10
## Overview
<br/>
<br/>
Copy link
Contributor Author

Choose a reason for hiding this comment

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

We had a mix of <br/> versus a new <h2> across the docs. I think the line breaks look better because then we don't have an effectively empty h1 with just a modes bar followed by an h2. I aligned them all to match

Copy link
Contributor

Choose a reason for hiding this comment

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

Yeah, the <br />s were basically me being lazy and not fixing any spacing issues with the modes bar

I think the pattern Ryan had started was always having an "overview" section at the top of every file (example)

image

I personally don't super care. I think either is fine, but long term should probably just clean up the css to avoid this <br />s 😅

I went ahead and opened an issue on react-router-website to address this eventually. This is good for now though

@brophdawg11 brophdawg11 force-pushed the brophdawg11/add-modes branch from ee1c6de to 1939905 Compare July 2, 2025 14:47
brookslybrand
brookslybrand reviewed Jul 2, 2025
View reviewed changes
docs/how-to/accessibility.md
@@ -10,12 +10,22 @@ React Router makes certain accessibility practices the default where possible an

## Links

[MODES: framework,data,declarative]
Copy link
Contributor

Choose a reason for hiding this comment

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

Really small nit, just for consistency

Suggested change
[MODES: framework,data,declarative]
[MODES: framework, data, declarative]

brookslybrand
brookslybrand reviewed Jul 2, 2025
View reviewed changes
docs/how-to/error-boundary.md
@@ -4,6 +4,11 @@ title: Error Boundaries

# Error Boundaries

[MODES: framework,data]
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
[MODES: framework,data]
[MODES: framework, data]

brookslybrand
brookslybrand reviewed Jul 2, 2025
View reviewed changes
docs/how-to/fetchers.md
@@ -4,6 +4,11 @@ title: Using Fetchers

# Using Fetchers

[MODES: framework,data]
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
[MODES: framework,data]
[MODES: framework, data]

brookslybrand
brookslybrand reviewed Jul 2, 2025
View reviewed changes
docs/how-to/form-validation.md
@@ -4,6 +4,11 @@ title: Form Validation

# Form Validation

[MODES: framework,data]
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
[MODES: framework,data]
[MODES: framework, data]

brookslybrand
brookslybrand reviewed Jul 2, 2025
View reviewed changes
docs/how-to/resource-routes.md
@@ -4,6 +4,11 @@ title: Resource Routes

# Resource Routes

[MODES: framework,data]
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
[MODES: framework,data]
[MODES: framework, data]

brookslybrand
brookslybrand reviewed Jul 2, 2025
View reviewed changes
docs/how-to/status.md
@@ -4,6 +4,11 @@ title: Status Codes

# Status Codes

[MODES: framework,data]
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
[MODES: framework,data]
[MODES: framework ,data]

brookslybrand
brookslybrand reviewed Jul 2, 2025
View reviewed changes
docs/how-to/suspense.md
@@ -4,6 +4,11 @@ title: Streaming with Suspense

# Streaming with Suspense

[MODES: framework,data]
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
[MODES: framework,data]
[MODES: framework, data]

brookslybrand
brookslybrand reviewed Jul 2, 2025
View reviewed changes
docs/how-to/view-transitions.md
@@ -4,6 +4,11 @@ title: View Transitions

# View Transitions

[MODES: framework,data]
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
[MODES: framework,data]
[MODES: framework, data]

brookslybrand
brookslybrand approved these changes Jul 2, 2025
View reviewed changes
Copy link
Contributor

@brookslybrand brookslybrand left a comment

Choose a reason for hiding this comment

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

Thanks @brophdawg11!

Sorry, I got really nitty with the spacing. It really doesn't matter, but I'd already started so I didn't stop. I don't care if you don't commit those, haha

@MichaelDeBoey MichaelDeBoey changed the title Add modes to all explanation/how to docs docs: Add modes to all explanation/how to Jul 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@MichaelDeBoey MichaelDeBoey MichaelDeBoey approved these changes

@brookslybrand brookslybrand brookslybrand approved these changes

Assignees
No one assigned
Labels
CLA Signed docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@brophdawg11 @MichaelDeBoey @brookslybrand