Native English speaker proofreading of the documentation

[MattiSG]

While #272 fixed some mistakes, there has been no full proofreading of the documentation by a native English speaker.

Any review, even partial, would be very welcome to catch and correct typos and weird phrasings!

As described in #111, many examples and references date back from before internationalisation of the project and are still specific to France. While it might not be possible for a new contributor to convert those references properly, it would already be very useful to list them explicitly, so that contributors with more context can decide to convert, update or altogether remove them.

[ShabanaNaik]

Hello, @MattiSG. I can proofread the documentation or at least provide a list of required changes. Let me know if this is still up for grabs. And do let me know which documents specifically you want a proofread.

[Br3nda]

@ShabanaNaik yes please! Anything on this repo where you find grammatical mistakes or room for improvement. Would you be comfy sending changes as pull requests?

[ShabanaNaik]

@Br3nda Yes, Definitely can do that. Thank you for the opportunity 😊.

[MattiSG]

Hi @ShabanaNaik, this is still very relevant, thanks for considering working on this topic 😊

You can read the full documentation in its context on https://openfisca.org/doc/, and can edit the source documents in https://github.com/openfisca/openfisca-doc/tree/master/source. Please let us know if you need any assistance getting started! 👍

(and thanks @Br3nda for your quick reply 🙏 )

[ShabanaNaik]

Hello,@MattiSG.😊
I've started working on proofreading the documents. Reading through issues #111 and #272 and the comments I understood that the documentation should be in British English. I have been editing the docs considering that. Let me know if I am correct or wrong.
I will reach out to you if I get stuck anywhere while editing☺.

[MattiSG]

Amazing, thanks @ShabanaNaik! 😃

I confirm that we prefer British English 👍

I recommend that you release early, release often: opening pull requests regularly will make sure that your work does not get stuck, and will decrease the risks of conflicts arising from parallel edits. Small pull requests are also more likely to be reviewed fast, and will enable you to get feedback early to incorporate in further work 🙂

It is very likely that we already will run in conflicts, since I just merged #267 that added linting (formatting checks) to Markdown files, meaning that many have seen their format being modified. No worries, we'll help you with handling conflicts if necessary 🙂

[ShabanaNaik]

You just answered one of my doubts!😅. I have been wondering if I should make a pull request for the editing I did so far or make one PR after completing proofreading. I will make small PRs, then.
Thanks for the link learnt a new concept today.😊 and for your help.

[MattiSG]

Thank you for the time you invest in contributing to open-source 💖

[ShabanaNaik]

I forgot to mention that the image (logo_mini.svg) is not loading in the side nav bar in docs. Need to get that corrected.

[MattiSG]

Thank for spotting that! The best would be to open a new issue, so we can track that problem independently from others 🙂 Would you feel like doing that? Attaching a screenshot would make it extra clear so everyone can understand the problem.

[MattiSG]

Hey @ShabanaNaik! Are you still interested in proofreading the rest of the documentation? Can we help you with anything? 🙂

[MattiSG]

@verbman are there still some parts left to handle following #298 #301 #302 #303 #306? If so, could you please list them here? If not, could you please close this issue? 🙂