Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update web ide doc #933

Merged
merged 8 commits into from
May 14, 2024
Merged

docs: update web ide doc #933

merged 8 commits into from
May 14, 2024

Conversation

TC-MO
Copy link
Contributor

@TC-MO TC-MO commented Apr 21, 2024

restructured the doc for better clarity
renamed headings
added admonitions

restructured the doc for better clarity
renamed headings
added admonitions
@github-actions github-actions bot added the t-docs Issues owned by technical writing team. label Apr 21, 2024
@TC-MO TC-MO requested a review from jbartadev May 9, 2024 12:35
Copy link
Member

@jbartadev jbartadev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice updates! A couple of questions

changed the wording
removed mentions of prompt for Actor's name
changed naming from [actor_name] to your-acotr-name for consistency
added link to apify-cli docs
@TC-MO TC-MO requested a review from jbartadev May 13, 2024 10:32
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One more generic question: Shouldn't we use .webp format for all the images? I'm not sure if it can be generated by Docusarus by default but I can use we use .png almost everywhere 😢

Also maybe some size optimizations could be useful? I see you reduced the size of the images so thumbs up for that 👍

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

never occured to me, but this might worth talking about I'll make a note of it and try to raise it in the near future. I'll also try to do some research how docusaurus handles .webp

Copy link
Member

@jbartadev jbartadev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good from my side, thanks for the updates!

@TC-MO TC-MO merged commit 917e361 into master May 14, 2024
8 checks passed
@TC-MO TC-MO deleted the development-web-ide branch May 14, 2024 13:40
honzajavorek pushed a commit to honzajavorek/apify-docs that referenced this pull request May 20, 2024
restructured the doc for better clarity
renamed headings
added admonitions
honzajavorek pushed a commit to honzajavorek/apify-docs that referenced this pull request May 21, 2024
restructured the doc for better clarity
renamed headings
added admonitions
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
t-docs Issues owned by technical writing team.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants