Add Writing Style Guide

[Faolain]

• Contributor's Guide: Writing Style Guide #98

[Faolain]

Not sure why the linter failed, ran npm run lint:fix & npm run lint:check and everything seemed to be fine

[lehnberg]

Good job, this is really great! See my nitpicky comments.

[lehnberg]

Consider also linking to this guide from contributors/README.md

[Faolain]

will submit to the main contributors README all the following links once done merging the others (writing style guide, getting started with gitbook & github etc) if that's ok?

[lehnberg]

Yes, sure 👍

[lehnberg]

Consider using the level 4 header #### for these throughout the document instead of bold text.

[Faolain]

hmm may push back on this one here haha since a header implies/indicates some distinct "Class"/Section which everything lives under that merits its own heading (especially if we autogenerate ToC). In this case, the bold just serves to stress I think which should suffice?

[lehnberg]

Sure, fair enough. Good push back! 👍

[lehnberg]

@Faolain the CI reports back broken links:

ERROR: 5 dead links found!
349
[✖] developers/naming-convention.md → Status: 400
350
[✖] [https://docs.microsoft.com/en-us/contribute/how-to-write-links](https://docs.microsoft.com/en-us/contribute/how-to-write-links) → Status: 400
351
[✖] /en/contribute/content/ → Status: 400
352
[✖] https://www.powerthesaurus.org/ → Status: 403
353
[✖] contributors/contributor-tools.md → Status: 400
354

→ Can you update with these fixed pls? Sorry, didn't catch this until I was about to merge it. :/

[Faolain]

@Faolain the CI reports back broken links:

ERROR: 5 dead links found!
349
[✖] developers/naming-convention.md → Status: 400
350
[✖] [https://docs.microsoft.com/en-us/contribute/how-to-write-links](https://docs.microsoft.com/en-us/contribute/how-to-write-links) → Status: 400
351
[✖] /en/contribute/content/ → Status: 400
352
[✖] https://www.powerthesaurus.org/ → Status: 403
353
[✖] contributors/contributor-tools.md → Status: 400
354

→ Can you update with these fixed pls? Sorry, didn't catch this until I was about to merge it. :/

No worries, hmm I'm not sure I know how to fix these?

• For developers/naming-convention.md → Status: 400 I currently reference it as [Yearn Naming Conventions](developers/naming-convention.md). Should it instead be [Yearn Naming Conventions](../developers/naming-convention.md) to account for the folder structure? I'm not sure how one can reference another page using relative links, if it's relative to the current folder or if it uses the root of the gitbook project. I'm unable to build this locally to test so would love to know for future reference (maybe we can also include this information in the guide - very meta lol).

• I was able to visit https://docs.microsoft.com/en-us/contribute/how-to-write-links so I'm not sure what this linter wants here?

• /en/contribute/content/ I can just change to match the absolute link

• https://www.powerthesaurus.org/ also seems to work not sure what it is failing?

• Similar relative link question as Website Pathing Links to Deprecated Docs #1 and dependency to be merged in here (which thanks for reminding me to submit hah) Contributor's Guide: Contributor Tools  #101

Update: In trying to fix these links I think I made it worse since now the linter doesn't even progress to checking links and fails at the start. Unsure how to proceed here.

[lehnberg]

Approving, and merging. CI failed, due to it marking https://www.powerthesaurus.org as broken, but it's not so going ahead.