devdocs
devdocs copied to clipboard
Update react router documentation
Updating existing documentation to its latest version
This PR updates the React Router documentation to version 6.10.0, and ensures that the documentation's entry in the about_tmpl.coffee file matches its data in self.attribution.
- Updated the versions and releases in the scraper file located at
lib/docs/scrapper/react_router.rb. - Updated the
favicon.icolink inSOURCElocated inpublic/icons/docs/react_routerto the latest version. - Ensured the icons and the
SOURCEfile inpublic/icons/docs/react_routerare up-to-date. - Ensured
self.linkscontains up-to-date urls ifself.linksis defined.
Tested the changes locally to ensure:
- The scraper still works without errors.
- The scraped documentation still looks consistent with the rest of DevDocs.
- The categorization of entries is still good.
Checklist
Please make sure that your PR fulfills the following requirements:
- [x] The PR title is descriptive and clear.
- [x] Changes are in a separate branch and follow the naming convention:
fix/<issue-number>-short-description. - [x] The PR description clearly describes the problem and the solution.
- [x] Code is properly formatted and follows the project's style guide.
- [x] All tests are passing.
- [x] The branch is up-to-date with the base branch.
Related Issues
Closes #1970
bundle exec thor docs:generate --force --package react_router
bundle exec thor docs:generate --force --package react_router
Entries: (2 KB, +0 KB)
Updated: 21
Created: 0
Deleted: 0
Types:
Updated: 1
Created: 0
Deleted: 0
Files: (0.1 MB, +0.0 MB)
Updated: 1
Created: 0
Deleted: 0
Done
Sorry for the late response. It is working fine on my end, can you specify what other changes should i make, I am a little bit confused about this one. Thanks!
Plenty of pages were missing since everything "outside" self.base_url is omitted.
There're still some problems, e.g. https://reactrouter.com/en/6.14.1/router-components/hash-router cannot be scraped since its entire content is encoded as JavaScript and stored as global variable window.__remixContext...