docs: restructure content on index page #1278
Conversation
… page Restructured the content into sections for better organization Expanded on the publishing process and stages Provided more detailed guidance on maintaining public Actors Added a section on handling breaking changes Emphasized the importance of clear documentation and testing Included additional sources for generating ideas for new Actors Incorporated examples from the Apify blog to illustrate Actor presentations Formatted the content in clean Markdown for better readability
Added new section about benefits of publishing & monetization Added details HTML component with hidden table Mentioned briefly the available pricing model
| - Flexible sharing options with public or private source code settings | ||
| - Complete API documentation and integration examples | ||
|
|
||
| <details> |
There was a problem hiding this comment.
I find this table a bit confusing, as it shows there is equality between hosting your own SaaS and building Actors. Can we communicate this somehow better and clearer? And probably merge with the above bulletpoints as they repeat the same thing.
There was a problem hiding this comment.
Yeah the table worked much better in my mind, I'll tinker with it more to better represent the difference between Traditional SaaS & Apify.
| If you decide to make your Actor code publicly available on [GitHub](https://github.com), its quality becomes a priority since your Actor could be a new user's first experience with Apify. | ||
| If you decide to make your Actor's code publicly available on [GitHub](https://github.com), code quality becomes even more crucial, as your Actor may be the first experience some users have with Apify. | ||
|
|
||
| ### Handling breaking changes |
There was a problem hiding this comment.
Here we should provide some best practices regarding versioning the Actors, e.g. use version-X tags. Do we have some page about that?
There was a problem hiding this comment.
Closest page where we describe versioning is here. But I guess that is more of an explanation than any kind of best practices, not sure if that would be suitable
Fixed typos Added links to Discord community & hire-freelancers channel Reworded according to suggestions
Removed confusing table Expanded upon benefits & monetization through bullet points Restructured the section
| Public Actors are regularly submitted to [automated tests](/platform/actors/publishing/test) to ensure they are functioning properly. Before making an Actor public, we recommend you reserve enough time to maintain the project (~2 hours weekly). This will ensure that your Actor maintains its long-term quality, improving your chances of successfully [monetizing your Actors](./monetize.mdx). | ||
| ## Maintain public Actors | ||
|
|
||
| While private Actors don't necessarily require ongoing maintenance, public Actors demand a highres level of resonsibility. Since public Actors are available on the [Apify Store](https://apify.com/store) and may be used by other users, an unmaintained public Actor could negatively impact those who depend on it. |
There was a problem hiding this comment.
typo, supposed to be higher, I will also review our typo checker
Restructured the content into sections for better organization
Expanded on the publishing process and stages
Provided more detailed guidance on maintaining public Actors
Added a section on handling breaking changes
Emphasized the importance of clear documentation and testing
Included additional sources for generating ideas for new Actors
Incorporated examples from the Apify blog to illustrate Actor
presentations
Formatted the content in clean Markdown for better readability