Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@ During this transition:

---

- [docs/contributor-info/Releasing](./docs/contributor-info/releasing.md) for instructions on releasing.
- [docs/contributor-info/pull-requests](./docs/contributor-info/pull-requests.md)
- [docs/contributor-info/rbs-type-signatures](./docs/contributor-info/rbs-type-signatures.md) for information on RBS type signatures
- See other docs in [docs/contributor-info](./docs/contributor-info)
- [internal/contributor-info/Releasing](./internal/contributor-info/releasing.md) for instructions on releasing.
- [internal/contributor-info/pull-requests](./internal/contributor-info/pull-requests.md)
- [internal/contributor-info/rbs-type-signatures](./internal/contributor-info/rbs-type-signatures.md) for information on RBS type signatures
- See other docs in [internal/contributor-info](./internal/contributor-info)

## Prerequisites

Expand Down Expand Up @@ -537,7 +537,7 @@ The CI system intelligently skips unnecessary work:
| JS code only | Skips Ruby-only tests | ~30% |
| Workflow changes | Runs lint only | ~75% |

For more details, see [`docs/contributor-info/ci-optimization.md`](./docs/contributor-info/ci-optimization.md).
For more details, see [`internal/contributor-info/ci-optimization.md`](./internal/contributor-info/ci-optimization.md).

### CI Control Commands

Expand Down Expand Up @@ -703,7 +703,7 @@ yalc add react-on-rails

### Testing the Generator

The generators are covered by generator tests using Rails's generator testing helpers, but it never hurts to do a sanity check and explore the API. See [generator-testing.md](docs/contributor-info/generator-testing.md) for a script on how to run the generator on a fresh project.
The generators are covered by generator tests using Rails's generator testing helpers, but it never hurts to do a sanity check and explore the API. See [generator-testing.md](internal/contributor-info/generator-testing.md) for a script on how to run the generator on a fresh project.

`rake run_rspec:shakapacker_examples_basic` is a great way to run tests on one generator. Once that works, you should run `rake run_rspec:shakapacker_examples`. Be aware that this will create a huge number of files under a `/gen-examples` directory. You should be sure to exclude this directory from your IDE and delete it once your testing is done.

Expand Down
6 changes: 3 additions & 3 deletions SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,9 +72,9 @@ Here is the new link:

## **[CONTRIBUTING](CONTRIBUTING.md)**

- [Generator Testing](./docs/contributor-info/generator-testing.md)
- [Linting](./docs/contributor-info/linters.md)
- [Releasing](./docs/contributor-info/releasing.md)
- [Generator Testing](./internal/contributor-info/generator-testing.md)
- [Linting](./internal/contributor-info/linters.md)
- [Releasing](./internal/contributor-info/releasing.md)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

SUMMARY.md is used as a table of contents file (commonly by GitBook or similar doc tooling). Linking to ./internal/ paths here means the published docs site would reference files that are intentionally excluded from publishing — potentially generating broken links for end users. While the file is marked "OLD DOCS BELOW" and may no longer drive publishing, it's worth verifying that no doc pipeline still reads it.


## **Misc**

Expand Down
1 change: 0 additions & 1 deletion docs/misc/doctrine.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@ The React on Rails setup provides several key components related to front-end de

- React on Rails has taken the hard work out of figuring out the JavaScript tooling that works best with Rails. Not only could you spend lots of time researching different tooling, but then you'd have to figure out how to splice it all together. This is where a lot of "JavaScript fatigue" comes from. The following keep the code clean and consistent:
- [Style Guide](./style.md)
- [linters](../contributor-info/linters.md)

We're big believers in this quote from the Rails Doctrine:

Expand Down
14 changes: 14 additions & 0 deletions internal/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Internal Documentation

This directory holds internal-only documentation that should not be published on the ShakaCode docs site.

## What lives here

- `internal/contributor-info/`: contributor workflows, release process, CI optimization notes
- `internal/planning/`: planning notes, drafts, and historical analysis
- `internal/react_on_rails_pro/contributors-info/`: Pro-internal contributor notes

## Publishing rule

- User-facing docs belong in `docs/` and `react_on_rails_pro/docs/`.
- Internal docs belong in `internal/`.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ React on Rails Pro is now released together with React on Rails using a unified

Please refer to the main release documentation:

👉 **[/docs/contributor-info/releasing.md](../../../docs/contributor-info/releasing.md)**
👉 **[/internal/contributor-info/releasing.md](../../contributor-info/releasing.md)**

Or run from the repository root:

Expand Down
4 changes: 2 additions & 2 deletions react_on_rails_pro/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ script/ci-changes-detector origin/master
- Push Pro changes without testing locally first
- Modify both Pro and main gem without running full tests

For comprehensive CI documentation, see [`../docs/contributor-info/ci-optimization.md`](../docs/contributor-info/ci-optimization.md) in the repository root.
For comprehensive CI documentation, see [`../internal/contributor-info/ci-optimization.md`](../internal/contributor-info/ci-optimization.md) in the repository root.

# IDE/Editor Setup

Expand Down Expand Up @@ -395,5 +395,5 @@ rake release[17.0.0,false,verdaccio]

For complete documentation, see:

- [Root Release Documentation](../docs/contributor-info/releasing.md)
- [Root Release Documentation](../internal/contributor-info/releasing.md)
- Run `rake -D release` for inline help
Loading