ac000
commented
2 months ago Hi Ava, just some general comments.
We try to keep commit subjects in the 50-70 character range (full documentation covering all this is coming!).
Perhaps you could make the subject Add additional information to the README or some such and use the existing subject as the body (keeping the body to 72 or less character lines).
Bonus points for the s-o-b though!
About the changes themselves, if you look closely, you'll notice that we try to keep the text in the README to < 80 character lines (except for things like URLs, commands and output etc).
I noted that our Docker instructions don't provide a complete quickstart, and leaves the user thinking about what additional steps need to be taken to host their application. While this isn't too hard to figure out on it's own I find that just having the instruction there saves time otherwise spent looking at examples and finding/reading the Dockerfile.
Additionally, after stumbling on our deprecated WASM functionality before the supported component; I found it prudent to show our WASM documentation front and center. Hopefully this will spare potential users any confusion they get finding the wrong thing first.
Finally, I wanted to point out the configuration docs in their own section, because I missed the single inline link we have to them the first two times I read through our Readme.