Skip to content

Commit c4e50d7

Browse files
committed
docs: polish roku repo docs
1 parent a46bee2 commit c4e50d7

4 files changed

Lines changed: 10 additions & 11 deletions

File tree

AGENTS.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@
77

88
## Start Here
99

10-
- [README.md](./README.md)
11-
- [CONTRIBUTING.md](./CONTRIBUTING.md)
12-
- [SECURITY.md](./SECURITY.md)
10+
- [Overview](./README.md)
11+
- [Contributing](./CONTRIBUTING.md)
12+
- [Security](./SECURITY.md)
1313

1414
## Commands
1515

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Supported variables:
2121
- `ROKU_DEV_TARGET` for the IP address of a developer-enabled Roku device
2222
- `ROKU_DEV_PASSWORD` for the Roku Developer Mode password when authenticated installs are required
2323

24-
If you need help enabling Developer Mode on the device itself, use [docs/SIDELOADING.md](./docs/SIDELOADING.md)
24+
If you need help enabling Developer Mode on the device itself, use the [Sideloading guide](./docs/SIDELOADING.md)
2525

2626
## Run Locally
2727

README.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@
1919

2020
Roku no longer supports private channels, so put.io on Roku is installed by sideloading.
2121

22-
For most users, the right path is the published ZIP and the step-by-step guide in [docs/SIDELOADING.md](./docs/SIDELOADING.md)
22+
For most users, the right path is the published ZIP and the step-by-step [Sideloading guide](./docs/SIDELOADING.md)
2323

24-
If you are working on the app itself, you can also sideload a ZIP generated from this repository. Start with [CONTRIBUTING.md](./CONTRIBUTING.md)
24+
If you are working on the app itself, you can also sideload a ZIP generated from this repository. Start with [Contributing](./CONTRIBUTING.md)
2525

2626
## Use
2727

@@ -35,13 +35,12 @@ After installation, sign in with your put.io account to:
3535

3636
## Docs
3737

38-
- [docs/SIDELOADING.md](./docs/SIDELOADING.md) for device setup and ZIP installation
39-
- [CONTRIBUTING.md](./CONTRIBUTING.md) for local setup, validation, and PR workflow
40-
- [SECURITY.md](./SECURITY.md) for private vulnerability reporting
38+
- [Sideloading guide](./docs/SIDELOADING.md) for device setup and ZIP installation
39+
- [Security](./SECURITY.md) for private vulnerability reporting
4140

4241
## Contributing
4342

44-
Contributions are welcome. Use [CONTRIBUTING.md](./CONTRIBUTING.md) for the contributor workflow and local sideload setup.
43+
Contributions are welcome. Use [Contributing](./CONTRIBUTING.md) for the contributor workflow and local sideload setup.
4544

4645
## License
4746

docs/SIDELOADING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,4 +75,4 @@ Useful commands:
7575
- `make verify` builds a fresh ZIP and runs the desktop BrightScript checker when available locally
7676
- `make artifact` creates `dist/apps/putio-roku-v2.zip`
7777

78-
For the full contributor workflow, see [../CONTRIBUTING.md](../CONTRIBUTING.md)
78+
For the full contributor workflow, see [Contributing](../CONTRIBUTING.md)

0 commit comments

Comments
 (0)