Skip to content

docs: serve documentation from rnrr.appandflow.com #39

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

Merged
janicduplessis merged 2 commits into from
Oct 5, 2026
Merged

docs: serve documentation from rnrr.appandflow.com #39

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
868ac06
docs: serve documentation from rnrr.appandflow.com
charlesvinette Sep 29, 2026
666be2e
Merge main into docs/rnrr-custom-domain
janicduplessis Oct 5, 2026
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
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,11 +99,11 @@ events. Android measures after Fabric mounting
and again on its own relayout, fold changes and window inset changes; scrolling
or moving an ancestor does not trigger a measurement. On iOS, same-frame delivery requires React Native
[#58530](https://github.com/react/react-native/pull/58530); see
[measurement timing](https://appandflow.github.io/react-native-reserved-regions/docs/platforms#measurement-timing).
[measurement timing](https://rnrr.appandflow.com/docs/platforms#measurement-timing).
Readiness indicates a completed measurement, not a
universal first-frame guarantee.

The [Usage guide](https://appandflow.github.io/react-native-reserved-regions/docs/usage#wait-before-rendering)
The [Usage guide](https://rnrr.appandflow.com/docs/usage#wait-before-rendering)
shows how to wait for the first measurement before rendering content.

## Development
Expand Down
4 changes: 2 additions & 2 deletions website/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,14 @@ pnpm install
pnpm run docs:start
```

Open the URL printed by Docusaurus. The site uses the `/react-native-reserved-regions/` base path.
Open the URL printed by Docusaurus. The site uses the `/` base path.

```sh
pnpm run format:check
pnpm run docs:build
pnpm --filter reserved-regions-docs serve
```

The build fails on broken internal links and produces `website/build/`. The configuration targets a possible GitHub Pages deployment at `https://appandflow.github.io/react-native-reserved-regions/`; no deployment is performed by these commands. Update `url` and `baseUrl` before hosting elsewhere.
The build fails on broken internal links and produces `website/build/`. The site is deployed to GitHub Pages at `https://rnrr.appandflow.com/` by `.github/workflows/docs.yml`; these commands do not deploy. Update `url` and `baseUrl` before hosting elsewhere.

Docs describe the repository source. Update the release status in `docs/installation.md` when a new package is published. Native API changes should update `docs/api.md` and `docs/platforms.md` together.
4 changes: 2 additions & 2 deletions website/docusaurus.config.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ export default {
title: 'Reserved Regions',
tagline: 'Display divisions and occlusions in your React Native view coordinates.',
favicon: 'img/logo.png',
url: 'https://appandflow.github.io',
baseUrl: '/react-native-reserved-regions/',
url: 'https://rnrr.appandflow.com',
baseUrl: '/',
organizationName: 'appandflow',
projectName: 'react-native-reserved-regions',
trailingSlash: true,
Expand Down
Loading