ipfs-docs
ipfs-docs copied to clipboard
Adding "how to create new page" to `CONTRIBUTING.md`
This PR is in reference to issue #1264
- Image optimization came back clean!
- Vuepress build was successful!
@johnnymatthews @ElPaisano I may still want to add more screenshots or go into more detail about certain things. Let me know what you think.
@TMoMoreau made some general comments above, might be easier to just talk through them real quick
General comment: The vale linter is showing a Flesch Reading Ease score of 68.2, which is pretty good. According to that metric, it means that the document is "easily understood by 13- to 15-year-old students". However, the vale target is 70, which indicates "fairly easy to read".
The score is a function of:
- the average length of your sentences (measured by the number of words)
- the average number of syllables per word
I ran markdownlint which, among other things, checks if line length is greater than 80. (this is configurable). I saw a lot of output like:
projects/testFiles/CONTRIBUTING.md:126:81 MD013/line-length Line length [Expected: 80; Actual: 282]
projects/testFiles/CONTRIBUTING.md:131:81 MD013/line-length Line length [Expected: 80; Actual: 107]
projects/testFiles/CONTRIBUTING.md:133:81 MD013/line-length Line length [Expected: 80; Actual: 125]
projects/testFiles/CONTRIBUTING.md:137:81 MD013/line-length Line length [Expected: 80; Actual: 419]
projects/testFiles/CONTRIBUTING.md:139:81 MD013/line-length Line length [Expected: 80; Actual: 208]
projects/testFiles/CONTRIBUTING.md:145:81 MD013/line-length Line length [Expected: 80; Actual: 184]
So, just something to keep in mind. If possible, keep sentences as short as possible, as it will make the overall reading experience easier for most readers. This will also bring the readability score up.
markdown-link-check came back clean 💯
Noticed a few other errors that aren't in this PR scope but are in CONTRIBUTING.md. Might be good to fix these here.
Line 79: "There're". This should be "There are" Line 27: "Aquire". This should be "Acquire"
Line 79: "There're". This should be "There are"
Fixed this because it's weird. I do want it to be known though, that this is technically a grammatically correct contraction.
Glanced over it, looks solid to me 👍
- Image optimization came back clean!
- Vuepress build was successful!
Looks like I need @DannyS03 to approve as well to get the "changes requested" thing green.