docs icon indicating copy to clipboard operation
docs copied to clipboard

Overhaul of Parse Server Guide

Open dblythy opened this issue 4 years ago • 13 comments

This PR is intended to replace the README of the Parse Server repo, ensuring that all documentation is in one place.

I personally think that the README of the Parse Server repo should be stripped back to capture what Parse Server is about in a few lines, and then point to the docs for the most updated references.

Not sure if we want the contributors / sponsors on the site as well - I think it's a nice touch.

Closes #808

dblythy avatar Jan 04 '21 13:01 dblythy

Any further comments around this PR @TomWFox 😊

dblythy avatar Jan 31 '21 14:01 dblythy

I kind of thought I'd submitted a review on this but clearly not, it's still pending!

TomWFox avatar Feb 01 '21 18:02 TomWFox

No worries @TomWFox. No rush at all. If you have bulk changes suggested I can happily share my branch with you.

dblythy avatar Feb 01 '21 18:02 dblythy

Before merging, I'll have to go back through again and add changes to the GitHub readme, such as Localization.

dblythy avatar Feb 10 '21 17:02 dblythy

I have looked it all over now so we're getting there 😀

TomWFox avatar Feb 10 '21 22:02 TomWFox

I've added Localization but I couldn't get the table to format. Are markdown tables supported or do we need to reformat?

dblythy avatar Feb 11 '21 00:02 dblythy

Keep the empty lines before and after the table. Empty lines are missing at many places of the Localization part that you pasted. Try to keep the content and copy/paste without much modification, because empty lines are important in MD.

mtrezza avatar Feb 11 '21 01:02 mtrezza

Thanks! My mac must have removed them in the copy/paste bc I don't think I deliberately removed them.

Anyway, here's how the table looks now. Any ideas as to how to optimize?

Screen Shot 2021-02-11 at 12 33 34 pm

dblythy avatar Feb 11 '21 01:02 dblythy

Table formatting for the GitHub MD interpreter is a topic on its own - but it's possible. If you're interested, see here why.

mtrezza avatar Feb 11 '21 01:02 mtrezza

Markdown tables are not fun, learnt that the hard way!

Edit: feel free to play around with it but my guess is that a different format will work best here

TomWFox avatar Feb 11 '21 11:02 TomWFox

I agree with different format, like in the API docs. I also think this would be better placed in the docs than in the README.

mtrezza avatar Feb 11 '21 14:02 mtrezza

Is this ready for another review?

TomWFox avatar Feb 12 '21 00:02 TomWFox

Yes plz 👍

dblythy avatar Feb 12 '21 00:02 dblythy