Skip to content

initial stab at some tracing docs #26

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

Merged
merged 1 commit into from
Oct 2, 2015
Merged

Conversation

pmuellr
Copy link
Contributor

@pmuellr pmuellr commented Sep 29, 2015

for issue #22 "add docs directory to repo"

@Qard
Copy link
Member

Qard commented Sep 29, 2015

LGTM

@mikeal
Copy link
Contributor

mikeal commented Oct 1, 2015

This is awesome!

Is there anywhere that we are exposing these other than here? I'd like to get these viewable from the website.

@Qard
Copy link
Member

Qard commented Oct 1, 2015

I can help getting it into the docs repo. What are your thoughts on the progress docs state of some of this though? The trace_event.h stuff is not really usable at all yet, so I'm not sure what the value of having that on the website would be.

What might be interesting is to give working groups a more public-facing space to share progress and inform people what work needs to be done. People could just go digging in the github repos, but that doesn't feel quite as welcoming.

@AndreasMadsen
Copy link
Member

AsyncWrap is specifically left out of the official documentation so that it doesn't need to obey semver.

@Qard
Copy link
Member

Qard commented Oct 1, 2015

Yeah, I definitely wouldn't want to put this stuff in API docs; this is all use-at-your-own-risk material. It could use more visibility though.

@pmuellr
Copy link
Contributor Author

pmuellr commented Oct 2, 2015

@mikeal I think at this point the docs aren't really designed to be public-facing; we have lots of info collected over minutes, blog posts, other conversations, and these docs are intended to be a single place to collect that stuff.

For now.

Eventually, when/if anything becomes public-facing-able, totally makes sense to add to the official docs.

pmuellr added a commit that referenced this pull request Oct 2, 2015
initial stab at some tracing docs
@pmuellr pmuellr merged commit 92310f5 into nodejs:master Oct 2, 2015
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.

4 participants