fastapi icon indicating copy to clipboard operation
fastapi copied to clipboard

๐ŸŒ ๐Ÿ”  ๐Ÿ“„ ๐Ÿข Translate docs to Emoji ๐Ÿฅณ ๐ŸŽ‰ ๐Ÿ’ฅ ๐Ÿคฏ ๐Ÿคฏ

Open LeeeeT opened this issue 2 years ago โ€ข 9 comments

I just really love ๐Ÿ’• ๐Ÿคฉ the idea of adding some emojis ๐Ÿ˜„๐Ÿ˜๐Ÿ˜… here and there across the ๐Ÿ“„ docs ๐Ÿ“„ (like in here for example). So I decided to write โœ the entire documentation out of emojis ๐Ÿ’ฅ๐ŸŽ‰๐ŸŒŸ. All these words ๐Ÿคฎ๐Ÿคข and... fancy-looking letters.. ๐Ÿ‘Ž๐Ÿ‘Ž๐Ÿ‘Ž ugh... That's so boring ๐Ÿฅฑ. I believe reading documentation made of emojis will definitely (don't argues ๐Ÿ˜›๐Ÿคช) be much funnier ๐Ÿ˜ƒ and easier ๐Ÿ˜ป for beginners. Just take a look at a new awesome ๐Ÿ”ฅ async page ๐Ÿ”ฅ. So here it is, don't thank me. ๐Ÿ’ฅ๐Ÿ’ฏ๐Ÿ’ซโญ

LeeeeT avatar Sep 13 '22 17:09 LeeeeT

Codecov Report

Patch and project coverage have no change.

Comparison is base (cf73051) 100.00% compared to head (3b37ad3) 100.00%.

:exclamation: Current head 3b37ad3 differs from pull request most recent head 7b50132. Consider uploading reports for the commit 7b50132 to get more accurate results

Additional details and impacted files
@@            Coverage Diff            @@
##            master     #5385   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          540       540           
  Lines        13969     13951   -18     
=========================================
- Hits         13969     13951   -18     

see 10 files with indirect coverage changes

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.

codecov[bot] avatar Sep 13 '22 17:09 codecov[bot]

๐Ÿ“ Docs preview for commit 5590e385bdbb82afe727b09fd57d2a62fe2f638a at: https://6320bdb2dc53d17efc1ba804--fastapi.netlify.app

github-actions[bot] avatar Sep 13 '22 17:09 github-actions[bot]

๐Ÿ“ Docs preview for commit 3b37ad366909f467caf213f69700a5dd4aae4a0a at: https://6321d213a4b3527ed976768f--fastapi.netlify.app

github-actions[bot] avatar Sep 14 '22 13:09 github-actions[bot]

@FeeeeK ๐Ÿ”ฅ๐Ÿ”ฅ๐Ÿ”ฅ Fixed ๐Ÿ”ฅ๐Ÿ”ฅ๐Ÿ”ฅ

LeeeeT avatar Sep 14 '22 13:09 LeeeeT

Hey there! Is this coming from a joke or something somewhere else? :sweat_smile:

I imagine that given all the approvals and interactions, but I didn't see the original joke... :shrug:

tiangolo avatar Sep 14 '22 13:09 tiangolo

@FeeeeK ๐Ÿ”ฅ๐Ÿ”ฅ๐Ÿ”ฅ Fixed ๐Ÿ”ฅ๐Ÿ”ฅ๐Ÿ”ฅ

Great๐Ÿ’ซ, I think this is a very nice๐Ÿ‘ change, making the documentation๐Ÿ“ much friendlier๐Ÿ™Œ. It's a pity that the previousโฎ๏ธ version of the Concurrency and async / await documentation was removedโŒ, I really miss it๐Ÿฅฒ.

FeeeeK avatar Sep 14 '22 13:09 FeeeeK

Really ๐Ÿ˜ƒ๐Ÿ˜ƒ๐Ÿ˜ƒ cool ๐Ÿ˜๐Ÿ˜๐Ÿ™‚ idea ๐Ÿ‘๐Ÿง ๐Ÿซฆ bro ๐Ÿฅต๐Ÿ˜Ž๐Ÿฅต!!!

mrMiiao avatar Sep 14 '22 13:09 mrMiiao

@tiangolo You see right through us. Forgive us this joke. We're just really sad about the decision to remove the emojis in #3273. They made the documentation unusual and stand out from the documentation of other frameworks. That's why we wanted to bring back that distinctive feature, so we'd be very happy if you could merge this pull request.โค๏ธ

FeeeeK avatar Sep 14 '22 14:09 FeeeeK

I think I could do a full translation of all the pages as well as fix a few formatting issues if you would ever consider adding an emoji version of the documentation, just for fun ๐Ÿ˜Š

LeeeeT avatar Sep 14 '22 17:09 LeeeeT

๐Ÿ“ Docs preview for commit ecf3d1cc91068ddeee71b771b6ce5cc6eba302ec at: https://639ccb4a3508160ef30a90b7--fastapi.netlify.app

github-actions[bot] avatar Dec 16 '22 19:12 github-actions[bot]

So... I'm considering adding this for April Fool's Day. That's next April 1st. ๐Ÿค“๐Ÿ˜‚

tiangolo avatar Feb 07 '23 16:02 tiangolo

Cool! ๐Ÿฅณ I'm going to finish up translating the remaining pages and prepare this for merging as promised. ๐Ÿ˜„

LeeeeT avatar Feb 07 '23 18:02 LeeeeT

๐Ÿ“ Docs preview for commit d51f60ef96f930aef904ee4de9dc55eb2d6ead5d at: https://64090307112b5b1b116dc96e--fastapi.netlify.app

github-actions[bot] avatar Mar 08 '23 21:03 github-actions[bot]

LGTM

BrycensRanch avatar Mar 10 '23 23:03 BrycensRanch

@LeeeeT, I tried to send a review, but for some reason github just gives an error, I have already contacted support, I hope they will help, but for now please wait a bit.

FeeeeK avatar Mar 13 '23 02:03 FeeeeK

Well, @FeeeeK, you can submit a pull request with your proposed changes to my fork ๐Ÿ˜‹

LeeeeT avatar Mar 15 '23 12:03 LeeeeT

๐Ÿ“ Docs preview for commit 24527b5c6c9abc6fa0d922e8300b1b3650c500ab at: https://642663a0b548622487cc93a0--fastapi.netlify.app

github-actions[bot] avatar Mar 31 '23 04:03 github-actions[bot]

๐Ÿ“ Docs preview for commit d51f60ef96f930aef904ee4de9dc55eb2d6ead5d at: https://6426a87c996bf600a71bb68f--fastapi.netlify.app

github-actions[bot] avatar Mar 31 '23 09:03 github-actions[bot]

Now I know that github doesn't like this Screenshot_20230331-133513_GitHub.png

FeeeeK avatar Mar 31 '23 09:03 FeeeeK

๐Ÿ“ Docs preview for commit 924c274318e8717dc722fc160f4b073b5a0bb924 at: https://6426a9b35d5fc100b1db0463--fastapi.netlify.app

github-actions[bot] avatar Mar 31 '23 09:03 github-actions[bot]

@FeeeeK It's probably for the best... ๐Ÿ˜

LeeeeT avatar Mar 31 '23 09:03 LeeeeT

๐Ÿ“ Docs preview for commit 7b501325c647b5bed6dd3d7c618eef0e2fe53b20 at: https://6427f6b2a6d5896aca012137--fastapi.netlify.app

github-actions[bot] avatar Apr 01 '23 09:04 github-actions[bot]


I imagine you automatized parts of it, I would love to know how you did it!


@tiangolo For all this, regexes were used to separate the text from code blocks, and then the translation through Yandex translator (link), and after all this, I fixed some inaccuracies and broken emojis. I think this can also be automated and converted to GitHub action, but we need to make it a little more stable.

FeeeeK avatar Apr 01 '23 09:04 FeeeeK

Yea, it required some reverse engineering and use of private API in order to automate translating with Yandex. ๐Ÿ˜… And my script for extracting readable and translatable text from md files is... well, it's better not to see it. ๐Ÿ˜น๐Ÿ˜น Also, Yandex translator is far from ideal and some manual editing is required. So I don't think it should (and can) be automated. ๐Ÿซค

Anyway, I want to thank all the participants of this pull request. โค๏ธ You guys made the prank even funnier. ๐Ÿคช๐Ÿฅฐ

LeeeeT avatar Apr 01 '23 10:04 LeeeeT