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

perf_tools guide #715

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

beta-ziliani
Copy link
Member

No description provided.

@netlify
Copy link

netlify bot commented Oct 9, 2023

Deploy Preview for crystal-book ready!

Name Link
🔨 Latest commit c3df85b
🔍 Latest deploy log https://app.netlify.com/sites/crystal-book/deploys/65268aadfc4cc70008e31d51
😎 Deploy Preview https://deploy-preview-715--crystal-book.netlify.app/guides/profiling
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@beta-ziliani
Copy link
Member Author

the lint is complaining, but locally it works fine and the error is in a different file 🤷

docs/guides/profiling.md Outdated Show resolved Hide resolved
docs/guides/profiling.md Outdated Show resolved Hide resolved
@straight-shoota
Copy link
Member

Memory profiling and fiber trace are completely independent tools with separate purposes. They just happen to be distributed collectively in the same shard.
They are not directly related to each other, so they should have separate documentation. I'm fine with a Profiling section in the book, but there should be two sub pages.
The fact that they are in the same repo is also not a common property of all profiling tools. Others may be available in different ways. Hence the introduction paragraphe doesn't fit for a general Profiling page.

This entire document reads more like a blog post announcing the perf_tools repository. Maybe that's what it actually should be?

@beta-ziliani
Copy link
Member Author

This entire document reads more like a blog post announcing the perf_tools repository. Maybe that's what it actually should be?

It's intended to be documentation for people to learn how to build better Crystal programs. That doesn't belong to a post.

Happy to split it in two though.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants