-
Notifications
You must be signed in to change notification settings - Fork 212
Description
Refer this https://github.com/microsoft/react-native-windows-samples/blob/main/website/README.md and this PR for 0.79: https://github.com/microsoft/react-native-windows-samples/pull/1042/files
Do similar changes for 0.80.
The commands for that would be:
Cutting Documentation for a New React Native Windows Release
-
Update necessary version references in docs.
getting-started.md- make sure to update from "nightly" to "latest" and change the previous stable version from "latest" to "0.XX-stable" in react-native init.
-
Follow the Integration into the react-native-windows-samples-repo steps to add the latest API documentation.
-
If
win10-compat.mdhas changed since the last version cut, copy contents ofdocs/win10-compat.md:- The oldest version of
win10-compat.mdin versioned_docs should be replaced with the one fromdocs. Make sure to adjust the page id to match the older version. - Confirm all other old versions of
win10-compat.mdshould be deleted.
- The oldest version of
-
Snapshot the website for version 0.XX:
cd websiteyarn run version 0.XXyarn run fix-unbroken
This will create a new directory of versioned docs,
version-0.XX, inwebsite/versioned_docs. This will preserve all documents currently in thedocsdirectory and make them available as documentation for version 0.XX. For more information on versioning, click here. -
Edit
website/.unbroken_exclusionsand add the line!versioned_docs/version-0.XX/native-api/*-api-windows*.mdunderneath the other versioned doc exclusions listed at the top of the file. -
Update
support.jsand add/update the entry for the new version of React Native Windows with the correct release and Active Support Start Date X (ex: 6/27/22). Then make sure to edit the previous version's:- Maintenance Start Date (set to the last day of the month that's 1 month out from X, ex: 7/31/22)
- End of Support Date (set to the last day of the month that's 2 months out from X, ex: 9/30/22)
-
When you are ready for your new docs to be the default documentation on the website, edit
website/siteConfig.jsto point to 0.XX for itsdefaultVersionShownconstant.
Once all changes are done, run " npx markdown-spellcheck "website/versioned_docs//*.md" "!website/versioned_docs//-api-windows.md" --en-us --ignore-acronyms --ignore-numbers --report --color
"
and add all the spelling errors to .spelling file