docs: add a doc page for each locale #3654
Conversation
✅ Deploy Preview for fakerjs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## next #3654 +/- ##
==========================================
- Coverage 99.97% 99.97% -0.01%
==========================================
Files 2994 2994
Lines 236234 236234
Branches 941 940 -1
==========================================
- Hits 236177 236175 -2
- Misses 57 59 +2 🚀 New features to boost your workflow:
|
matthewmayer
added
c: docs
Shinigami92
left a comment
Shinigami92
left a comment
There was a problem hiding this comment.
Interesting idea. A bummer right now is that when visiting e.g. https://deploy-preview-3654.fakerjs.dev/locales/de.html the left sidebar is gone, and so as a user I loose UX / context.
|
LGTM, but CI error |
|
Don't really understand the error |
Some scripts that are running are checking and generating stuff in the docs folder. And if there is a diff mismatch, then it fails as there is e.g. a non-committed change. |
|
Fixed thanks |
xDivisionByZerox
left a comment
xDivisionByZerox
left a comment
There was a problem hiding this comment.
This looks like a great feature. 👍
I have some questions (sorry, Vue noob here) and suggestions. See comments.
Some general extensions I could see being added to this feature in the future:
- use the already existing "RefreshButton" component to reload the examples inline
- use Slots or TemplateRefs for easier/more fine grained post processing
- improve UX by giving the user feedback on which page they are (currently no entry is highlighted on the sidebar)
Co-authored-by: DivisionByZero <[email protected]>
|
i did consider using the RefreshButton but the code seems sufficiently different for it to not really help that much. For example, on the other docs pages we render the results which are already in the code block comments first, and only load the client-side JS on demand to refresh. But for locale pages we want to dynamically load on first load of the page. |
|
I'll merge this merge since Shini previously approved the PR. They are currently on vacation, so they cannot renew their approval. |
3 participants
Experimental idea: add a doc page for each locale. This would be an easy way to show off how Faker works in various languages, and maybe also be useful for SEO?