feat: add BeautifulSoup template README

[PerVillalva]

I'm starting with the Python SDK templates and will progressively commit the content for the remaining templates to this PR.

Please, let me know if you have any feedback regarding the structure of the README.

The content of the README will be displayed on the new Template Detail page, planned by the nux-team. For more information, please refer to the design and discussion in Figma.

[mnmkng]

I wonder whether including all those commands in the readme's is the best way to go. When some of them change (or update, or we want to add more stuff), we would have to change them in all the readmes. And I guess over time, there will be more "shared" logic.

• I suggest we either move this out from the readme and to web/platform. Something like the API tab in Actors, but not necessarily a separate tab. The info there is also auto-generated.
• Or, we could add another build script to this repo. The build script would take the template's readme without the commands and it would dynamically add all the shared parts. Then, in the built templates (zip files), the readmes would be full length.

[PerVillalva]

Good point @mnmkng. I'm following the current design, and the commands are the bulk of the information displayed on the Template Detail page. And, as far as I know, the content that will populate the Template Detail page is supposed to come from the template README.

I agree with your comment but I'm just not sure how I can go about solving this issue or with whom I should discuss it.

[PerVillalva]

@fnesveda Thanks for the info, Franta. I removed the code from the README.

[fnesveda]

@PerVillalva Maybe sync with @jbartadev about the best way to go about this 👍

[PerVillalva]

@fnesveda From my understanding, the primary reason for having these instructions on the README is that the README's content will be used to populate the content displayed on the dedicated template pages that will be added to the console (see discussion in Figma). And people who land on that page might not necessarily have run apify create.

[fnesveda]

@PerVillalva That I understand, but then what's the point of rendering the READMEs here? Why can't we just load the templates manifest on the web, and render the template pages there directly? It just feels too complicated this way.

[PerVillalva]

Hm, good point, @fnesveda. I was doing this way just because that's how I knew how to do it based on the information I had.

@HonzaTuron do you have any insights on how we could load the templates manifest on the web, and render the template pages there directly?

[mnmkng]

@fnesveda Because there was a requirement to make the readmes readable here on GitHub as well.

[fnesveda]

OK I guess, still feels unnecessary, I doubt that many people visit the actual templates source here.

[HonzaTuron]

@PerVillalva We have markdown renderer set-up on web so it would be enough to use it.

[PerVillalva]

@fnesveda Would you be ok with this solution for the time being? If necessary, we can revisit and improve it later.

[fnesveda]

Sure, it's not really a big deal

[PerVillalva]

@fnesveda Fixed. Thanks for the help, Franta!