Skip to content

Embedding dart examples into api docs #7011

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.

Sign up for GitHub

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

Jump to bottom
Closed
DartBot opened this issue Nov 28, 2012 · 8 comments
Closed

Embedding dart examples into api docs #7011

DartBot opened this issue Nov 28, 2012 · 8 comments
Labels
area-pkg Used for miscellaneous pkg/ packages not associated with specific area- teams. type-enhancement A request for a change that isn't a bug

Comments

@DartBot
Copy link

DartBot commented Nov 28, 2012

This issue was originally filed by @financecoding

It would be nice to maintain example code in documentation in a different repo with complete and runnable code examples. At api docs build time parts of those examples get merged into the respected locations of the source code comments.

Would be to provide developers with working samples they could clone or copy directly with ease (thinking embedded gist links on the docs site, like jekyll embedded gist)

The embeddable link should contain enough for the developer to download and run the example code with least amount of friction.

Giving the docs a feel/quality of the MSDN embedded code but with the power of being able to clone and work directly with a full sample.
@anders-sandholm
Copy link
Contributor

Removed Type-Defect label.
Added Type-Enhancement, Area-DartDoc, Triaged labels.

@DartBot
Copy link
Author

DartBot commented Mar 11, 2013

This comment was originally written by [email protected]

Issue #7544 has been merged into this issue.

@DartBot
Copy link
Author

DartBot commented Dec 20, 2013

This comment was originally written by [email protected]

it would be great

@anders-sandholm
Copy link
Contributor

Added old-dartdoc label.

@kevmoo
Copy link
Member

kevmoo commented Mar 17, 2014

Added Pkg-DartDoc label.

@kevmoo
Copy link
Member

kevmoo commented Mar 17, 2014

Removed Area-DartDoc label.
Added Area-Pkg label.

@kevmoo
Copy link
Member

kevmoo commented Apr 7, 2014

Removed Pkg-DartDoc label.
Added Pkg-DocGen label.

@sethladd
Copy link
Contributor

Moved to dart-lang/dartdoc#76

Added MovedToGithub label.

@DartBot DartBot added Type-Enhancement area-pkg Used for miscellaneous pkg/ packages not associated with specific area- teams. labels Jan 10, 2015
@kevmoo kevmoo added type-enhancement A request for a change that isn't a bug and removed type-enhancement labels Mar 1, 2016
@devx-ubiquity devx-ubiquity mentioned this issue May 27, 2025
Open
This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area-pkg Used for miscellaneous pkg/ packages not associated with specific area- teams. type-enhancement A request for a change that isn't a bug
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@sethladd @kevmoo @anders-sandholm @DartBot