-
-
Notifications
You must be signed in to change notification settings - Fork 943
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.
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
docs(upgrading): add link to upgrading snippets #2788
Conversation
✅ Deploy Preview for fakerjs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## next #2788 +/- ##
==========================================
- Coverage 99.96% 99.95% -0.01%
==========================================
Files 2971 2971
Lines 212553 212553
Branches 947 949 +2
==========================================
- Hits 212475 212466 -9
- Misses 78 87 +9 |
I'd rather concatenate all the snippets into the files. The alpha is useful for looking for mistakes in the docs as well as mistakes in the code, and that's easier with a concatenated file. |
Not sure about that. The reason we opted for these separate migration files was the idea to write a comprehensive migration files that makes sense in it's structure (order of section, grouping of related changes, etc). We would assentially do all this work twice by already concatinating all files. That being said, I'm not sure about simply puting a link to the snippet directory - the UX feels really bad. |
We could do a rough version just by deciding on a sensible order and noting down the order of files for future reference
|
IMO we could just merge the migration guide files together, since we already have most breaking stuff already. So before any release me merge the snippets into the main file. |
Currently the docs don't contain a hint how to upgrade.
https://next.fakerjs.dev/guide/upgrading.html
This PR adds a link to the individual snippets until we merge them into one big file.
https://deploy-preview-2788.fakerjs.dev/guide/upgrading.html