search

arviz-devs / GSoD

Repo about ArviZ participation in Google Season of Docs initiative
Apache License 2.0
5 stars 2 forks source link

Update project_idea.md #9

Closed dameeolawuyi closed 2 years ago

dameeolawuyi commented 2 years ago

Hi Oriol, I reviewed and addressed the comments I made in the original repo. I also made some edits to the doc where I felt it was necessary. Kindly review, thanks.

I am sorry for being a tad late with this.

OriolAbril commented 2 years ago

Thanks! Can you still keep the original line breaks? As this is markdown, line breaks without an empty line are not taken into account when rendering, and it makes reviewing and finding where exactly are the changes much easier.

You also have to be careful with the spacing within each line. For example, the lack of a space between the # characters and the text doesn't create a title, or similarly, the lack or a space between the - and the bullet point text doesn't create a bullet point either.

This is the link to the preview of the rendering build from this pr: https://arviz-gsod--9.org.readthedocs.build/en/9/2022/project_idea.html and this the link to the current rendered version: https://arviz-gsod.readthedocs.io/en/latest/2022/project_idea.html (which I guess is what you read originally)

I can also edit it directly and to fix these issues above once I have some extra time.

OriolAbril commented 2 years ago

Thanks!