docs: restructure content #1283
Conversation
Rephrased sections for better clarity and readability Added specific guidelines for each section, including examples and best practices Formatted the content in clean Markdown for better presentation Maintained developer-friendly language throughout
TC-MO
added
documentation
There was a problem hiding this comment.
Apart from a few nitpicks I think the most important fix should be regarding the README links, which do not make sense to me as they're now.
However, these links are already in the current version, so I don't consider it to be an error I'd block merging of this PR on. This PR brings many improvements, and keeps the links unchanged, which is net positive. I suggest we merge this right away and do bikeshedding about README links in a separate issue or PR.
|
|
||
| 3. **How much will it cost to scrape (target site)?** | ||
| <YOUR-VIDEO-LINK-HERE> |
There was a problem hiding this comment.
How come this is not https://www.youtube.com/watch?v=r8E0CbYZcjE
|
|
||
| 7. **Output** | ||
| Mention that the extracted dataset can be downloaded in various formats such as `JSON`, `HTML`,or `CSV`. Provide a simplified `JSON` dataset example to illustrate the output structure, check [this Actor](https://apify.com/compass/crawler-google-places#output-example) for an example. |
There was a problem hiding this comment.
There's a missing whitespace after the comma, but when suggesting that, I realized I wouldn't treat the abbreviations as code blocks. These are very common abbreviations in the programming world and I wouldn't think they deserve such emphasis.
| Mention that the extracted dataset can be downloaded in various formats such as `JSON`, `HTML`,or `CSV`. Provide a simplified `JSON` dataset example to illustrate the output structure, check [this Actor](https://apify.com/compass/crawler-google-places#output-example) for an example. | |
| Mention that the extracted dataset can be downloaded in various formats such as JSON, HTML, or CSV. Provide a simplified JSON dataset example to illustrate the output structure, check [this Actor](https://apify.com/compass/crawler-google-places#output-example) for an example. |
There was a problem hiding this comment.
After some consideration, that makes sense and I agree
|
|
||
| [How to Create a Beautiful README for Your GitHub Profile](https://yushi95.medium.com/how-to-create-a-beautiful-readme-for-your-github-profile-36957caa711c) | ||
| Not everything in there will be suitable for an Actor README, so you should cherry-pick what you like and use your imagination. |
There was a problem hiding this comment.
I think most of it won't be suitable, because those two articles talk about GitHub profile README, where you present yourself, not a GitHub repository README, where you present your project.
We could link to https://opensource.guide/starting-a-project/#writing-a-readme instead, which links https://www.makeareadme.com/ or https://gist.github.com/PurpleBooth/109311bb0361f32d87a2, but surely there are plenty of other articles which talk about how to make a good project README.
Rephrased sections for better clarity and readability
Added specific guidelines for each section, including examples and best
practices
Formatted the content in clean Markdown for better presentation
Maintained developer-friendly language throughout