docs(react-router): updating docs to reflect react router 6 changes#4422
docs(react-router): updating docs to reflect react router 6 changes#4422
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
brandyscarney
left a comment
There was a problem hiding this comment.
There are a lot of unrelated changes on this PR that should be the same as whatever is on the major-9.0 branch. Additionally, running npm start locally fails with:
Error: MDX compilation failed for file "/Users/brandyscarney/Developer/ionic-docs/versioned_docs/version-v8/reference/glossary.md"
Cause: Expected the closing tag `</a>` either after the end of `paragraph` (551:103) or another opening tag after the start of `paragraph` (550:7)
Details:
{
"column": 5,
"message": "Expected the closing tag `</a>` either after the end of `paragraph` (551:103) or another opening tag after the start of `paragraph` (550:7)",
"line": 551,
"name": "551:5-551:9",
"place": {
"start": {
"line": 551,
"column": 5,
"offset": 18407,
"_index": 2,
"_bufferIndex": 4
},
"end": {
"line": 551,
"column": 9,
"offset": 18411,
"_index": 2,
"_bufferIndex": 8
}
},
"reason": "Expected the closing tag `</a>` either after the end of `paragraph` (551:103) or another opening tag after the start of `paragraph` (550:7)",
"ruleId": "end-tag-mismatch",
"source": "mdast-util-mdx-jsx"
}
client (webpack 5.99.5) compiled with 1 errorI would recommend making a new branch off major-9.0, updating it from main, fixing any issues and lint errors on that branch and then merging that back into major-9.0. Update this branch from major-9.0 and then remove any unrelated file changes from this branch so it is purely RR6 related.
There was a problem hiding this comment.
Adding this here so it has a thread:
Don't we need to update the playgrounds as well or is that going to be done on a separate PR? See:
ionic-docs/static/usage/v9/tabs/router/react/main_tsx.md
Lines 19 to 30 in 1307564
There was a problem hiding this comment.
Excellent catch! Didn't even realize there were playgrounds for RR6. Fixed in d0f6f2f
There was a problem hiding this comment.
Do you also plan to update the React router dependencies here:
ionic-docs/static/code/stackblitz/v9/react/package.json
Lines 11 to 12 in 1307564
There was a problem hiding this comment.
Yep! Fixed in 76552ed, good additional call out
There was a problem hiding this comment.
Opened the React example at Tabs: Router, installed the dev build 8.8.1-dev.11774384072.1e807ca8 and ran the example. Everything looks good!
There was a problem hiding this comment.
Do you also plan to update the React router dependencies here:
ionic-docs/static/code/stackblitz/v9/react/package.json
Lines 11 to 12 in 1307564
Description
This PR is preparing the docs for React Router 6 in v9. This PR covers updating the breaking changes for v9 documentation, the migration guide for react router 6, and the react quick start guide.
A large chunk of this PR (everything in v8) is fixing files that previously didn't comply with prettier so that CI will pass.