soapdog / patchfox

A client for scuttlebutt network as a Firefox WebExtension
MIT License
169 stars 28 forks source link

Copy-edit the packages and filter docs #126

Closed camdendotlol closed 2 years ago

camdendotlol commented 2 years ago

This PR is a lot smaller than the last one. There were only a few places with legit grammar errors. I mostly just kept some style stuff consistent, like the capitalization of SourceHut and GitHub and the rules for bulleted lists.

Also, I went through the funding budget breakdown but stopped at https://github.com/soapdog/patchfox/blob/master/docs/funding/2021-funding-request.md because I wasn't sure if it's useful to copy-edit. It's well-written anyway, so I don't think it needs an editing round.

In the future I will do the message-types and troubleshooting folders, and the .md files in the root level of /docs. This will probably be a couple PRs.

soapdog commented 2 years ago

@mythmakerseven I didn't checked this thoroughly. Sorry.

You made a wonderful job, but it happened in the wrong location. The docs/packages folder is assembled dynamically. the original docs for each package are inside the respective package folder. So for docs/packages/zine, the real docs are in src/packages/zine/docs.

I didn't notice that you fixed it in the roots docs folder. The changes you made were overwritten by the next build.

soapdog commented 2 years ago

I'll try to cherry pick and apply those changes in the correct location.

You might want to check the copy-package-docs script which handles this.

camdendotlol commented 2 years ago

Sorry about that, I remember that section from the development docs but forgot about it when I submitted the PR. I'll see if I can fix it today.

I see now that most packages include a message_types folder with further documentation. I might add that to my copy-editing to-do list, but from glancing into a few, they don't seem to have any noticeable errors so it won't be a big priority.