Welcome to the Motte Quality Vault Reviews!
Would you like to help review and edit vault entries? We've got some work for you to do!
Here's the first prototype instructions, let me know if anything is unclear.
- Fork this repo, then clone your fork using Git.
- Go to the Issues page. Leave a comment on a post block saying that you're handling it (so nobody else grabs it.)
- Look over the entries in the numbered post block and edit them as per the instructions near the end.
- Check in your work, push it, and send a pull request.
- Repeat as you have time!
Post editing instructions:
In general, most of the things in a post shouldn't be edited, with two exceptions.
The first and most important exception is the title. Some of the titles just weren't intended for publication. Look at the title (in <title> tags) and, if necessary, modify it for publication. Titles should be spelled properly, punctuated properly, and capitalized properly as per title case (converter here, use AP-Style Title Case). They should not have a trailing period or exclamation point and should not be written as clickbait unless there's a really good reason (I'd accept "Ten TERRIFYING things you didn't know about clickbait!", for example). Check out the Vault's homepage for examples.
The second exception is context quotes. Some posts just make no sense without an introductory quote to see what they were responding to. On Reddit, people just hit "parent" and go read the context, but that's not an option here. Prepend www.reddit.com to the <link> and go visit it to see what it looks like; if it makes a lot more sense with a parent, you need to add a context quote.
The right way to do this is to create a <context> block before the <body>, then copy all relevant context in there. You can use full HTML in this block; please copy any formatting from your quotes as well (Inspect Element in your favorite web browser makes this easy, just copy and paste!) You can also nest quotes with <blockquote> tags.
If the post includes an existing but insufficient <blockquote>, move it out of the <body> and into a <context> with extra quotes as necessary. This is the only time you should be editing a <body>!
Examples of much of this can be found in the example_before and example_after directories. Title editing is shown in ymeskhout's post, <context> is added in Amadanb's, ymeskhout's, and ZorbaTHut's posts, with an existing blockquote hoisted from <body> to <context> in ZorbaTHut's example.
If the post was deleted by the user while leaving their account active, make a deleted subdirectory in the block subdirectory, and move it in there. If the user deleted their account only, or deleted their account and all posts, then (1) do the edit thing, and (2) make an anonymized directory in the block subdirectory and move it in there. (The codebase doesn't support anonymous entries yet, so I'll just shove them off in a corner of the database until I've got that implemented.)
If you're not entirely sure what to do with a post, do it anyway. Everything submitted will be reviewed by me; I'd rather have your best guess at the right solution than anything else. If you really don't know what to do with it, move it into a folder named REVIEW_ME and I'll handle it.
Finally, don't feel like you have to edit a post! Sometimes they're fine as-is.
Thank you in advance for your help!
Did you find a problem in the live site? There's currently no way for people to help me with that directly, but post an issue, with the URL included, and tell me what the problem is; I'll take care of it. Thank you also!
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent