Skip to content

chore: move documentation to dedicated repo#4012

Open
halskiszymon wants to merge 1 commit into
mainfrom
chore/move-docs-to-dedicated-repo
Open

chore: move documentation to dedicated repo#4012
halskiszymon wants to merge 1 commit into
mainfrom
chore/move-docs-to-dedicated-repo

Conversation

@halskiszymon
Copy link
Copy Markdown
Collaborator

@halskiszymon halskiszymon commented May 11, 2026

Draft changes - please don't review yet

Summary

The Docusaurus site that used to live in docs/ has been moved to its own repository: software-mansion/react-native-screens-docs. The published URL is unchanged — docs.swmansion.com/react-native-screens.

Changes

  • Remove the full docs/ Docusaurus site. History is preserved in the dedicated docs repo (extracted via git filter-repo --subdirectory-filter docs).
  • Replace docs/ with a small docs/README.md pointing readers to the new repo.
  • Add a "Documentation" section to the top-level README with the live URL and the source repo link.
  • Add an "Updated documentation in react-native-screens-docs" checkbox to the PR template so contributors are reminded to keep docs in sync when they change public API or behavior.

Why

The docs site has its own release cadence, build pipeline, and contributor workflow (recordings, ffmpeg conventions, versioning per major). Keeping it inline made dependabot bumps noisy and conflated two very different concerns. The dedicated repo cleans that up and unblocks the docs revamp targeting the 5.x release.

Test plan

  • CI passes (no docs-related steps left in this repo)
  • The new top-level README "Documentation" link resolves
  • PR template renders with the new checkbox

🤖 Generated with Claude Code

The Docusaurus site that used to live in `docs/` has been moved to
its own repository: software-mansion/react-native-screens-docs.
The published URL stays the same: docs.swmansion.com/react-native-screens.

- Remove the full docs/ Docusaurus site. History is preserved in the
  dedicated docs repo via git filter-repo.
- Replace docs/ with a small README pointing readers to the new repo.
- Add a "Documentation" section to the top-level README with the live
  URL and the source repo link.
- Add an "Updated documentation in react-native-screens-docs"
  checkbox to the PR template so contributors are reminded to keep
  docs in sync when changing public API or behavior.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@kkafar kkafar requested review from Copilot and kkafar and removed request for Copilot May 11, 2026 15:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant