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

"How to write code excerpts" in the readme #6339

Open
MaryaBelanger opened this issue Jan 17, 2025 · 1 comment
Open

"How to write code excerpts" in the readme #6339

MaryaBelanger opened this issue Jan 17, 2025 · 1 comment
Assignees
Labels
e1-hours Can complete in < 8 hours of normal, not dedicated, work infra.structure Relates to the tools that create dart.dev meta.docs Need to document something about the Dart.dev site p3-low Valid but not urgent concern. Resolve when possible. Encourage upvote to surface.

Comments

@MaryaBelanger
Copy link
Contributor

I feel like I explain the mechanics of code excerpts to contributors (both internal and external) quite a bit in PR reviews. Would it make sense to add a brief section that explains how to edit or write a new code excerpt (like, where the code goes and how to connect it to a code block on a md page) in the readme @parlough (since you're the readme author)? Maybe right before the refresh code excerpts section.

If that sgty, I'll add it in!

@parlough
Copy link
Member

I think this would be great to add. Either in the README or a section of the https://github.com/dart-lang/site-www/blob/main/CONTRIBUTING.md doc that the README could link to. Whichever you prefer!

@parlough parlough added infra.structure Relates to the tools that create dart.dev p3-low Valid but not urgent concern. Resolve when possible. Encourage upvote to surface. e1-hours Can complete in < 8 hours of normal, not dedicated, work meta.docs Need to document something about the Dart.dev site labels Feb 21, 2025
@parlough parlough assigned parlough and unassigned MaryaBelanger Feb 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
e1-hours Can complete in < 8 hours of normal, not dedicated, work infra.structure Relates to the tools that create dart.dev meta.docs Need to document something about the Dart.dev site p3-low Valid but not urgent concern. Resolve when possible. Encourage upvote to surface.
Projects
None yet
Development

No branches or pull requests

2 participants